PeopleSpheres API
Main (core) API for interaction with form, fields and other core things
Authorization
Most part of endpoints protected with authorization mechanism.
To authenticate your request you need to obtain authentication token in SSO service.
We are using KeyCloak as SSO server. Read motre about aouthorization in KeyCloak
docs.
This token should be passed with Authorization header.
Authentication header example: Authorization: Bearer KeyCloakTokenString
Please note - endpoints that requires authorization marked with small locker icon
API Versioning:
All API endpoints supports API versioning. To specify it you need to pass Accept header
Example: Accept: application/vnd.monportail.v1+json
Supported versions:
- v1
Detailed info about versions and difference between them will be specified for each API endpoint
Client Versioning
In order to not support outdated and legacy API endpoint for a long time every client must send specific header. This header need to know what is the app version. API will use it to figure out if it can handle this app or not
Header: X-Application-Version: <client-name>/<version>
-
client-name - one of ios or android
-
version - client version. It must be semantic version
Examples:
-
X-Application-Version: ios/1.0.0
-
X-Application-Version: android/4.67.15
Request
Different APIs requires different request. Each request described in related API section.
Definition for each request object we use can be found in Models section (bottom of the page)
Includes
In order to improve performance and give more control on response to cliend side
Most part of GET requests supports include option. It is optional and can be specified with as a query part of URL.
It may has comaseparated list of relations that need to be presented in response. Each API has their own set of
relations that will be listed for each API individually.
Includes supports kind of inheritanse. For example if you need to get in response fields relation with type for
all items it can be done as include=fields,fields.type
Examples:
/fields?include=items,category
/form/123?include=fields,fields.items,fields.category
Response
Each response (no matter if it single item or a list of items) wrapped with data node.
Each response comes with successful http code:
-
200- means request completed successfully. Usually contains data in body -
201- means new entity created successfully. Usually contains id of created entity in body -
202- means entity was successfully updated. Usually contains no data in body -
204- means there are no data to return. Usually happens for completedDELETErequests Definition for each response object we use can be found inModelssection (bottom of the page)
Example : Response with single object
{
'data': {
//...
}
}
Response with list of objects
{
'data': [
{
//...
},
{
//...
},
...
]
}
Data representation (mapping)
-
integer- number -
float|double- number -
string- string -
date- string, always formatted as YYYY-MM-DD HH:mm:ss. No timezone specified. Timezone always UTC.
Pagination
To increase performance most part of lists supports pagination.
It means that response will contain only limited number of items and special meta node (same level data node located) with pagination info.
Example structure
{
'data': [...],
'meta': {
'pagination': {
'total': 238,
'count': 25,
'per_page': 25,
'current_page': 2,
'total_pages': 10,
'links': {
'previous': 'http://example.com/api/users?page=1'
'next': 'http://example.com/api/users?page=3'
}
}
}
}
Please note that this meta node optional and appears ONLY if endpoint supports pagination. Also links for next and previous
pages depends on current_page and total_pages. So, for example, previous link will be omitted when results for 1st page
returned, same for next - will be omitted when last page reached.
Please note - you may skip pagination and get the whole list of items. To do it you need to pass no-pagination query option with positive value.
Example: GET /api/resources/data-types?no-pagination=1
Also it is possible to pass per-page query option to change default value (25). Example: GET /api/resources/data-types?per-page=5
Errors
There are few type of errors that can happens:
-
validation
-
authentication
-
authentication
-
not found
-
application/business logic
-
server/unexpected
Validation Error
Happens when data you submit fails against validation rules.
Such response will have 400 (Bad Request) http status code and contain error related information in body.
{
'message': '400 Bad Request',
'errors': [
'field_with_bad_data': [
'Reason of failed validation',
'Another reason of failed validation',
...
],
'another_field_with_bad_data': [
...
],
...
],
'status_code': 400
}
Please note that errors contains ONLY fields that fails against validation rules.
Each field can has MANY error messages, all of them listed in array
Authenticatio Error
Happens when protected API endpoint requested without (or with bad or expired) specified token.
{
'message': 'Short description of error reason',
'status_code': 401
}
Authorization Error
Happens if authenticated user has no access to specified endpoint.
{
'message': 'Short description of error reason',
'status_code': 403
}
Not Found Error
Happens if client trying to access not existing API endpoint or not existing entity identifier specified
{
'message': 'Short description of error reason',
'status_code': 404
}
Not Acceptable Error
In most cases the reason - client version is too old and not supported The main use case for it - restrict usage of old mobile application (in order to not maintain legacy API endpoints). See more details in section about versions
{
'message': 'Short description of error reason',
'status_code': 406
}
Application Errors
Happens when something went wrong from Business Logic point of view.
Such response will have 422 (Unprocessable Entity) http status code
{
'message': 'Descriptive error message',
'status_code': 422
}
Server Errors
There are small chance to get such error. In most cases it means that the server or a part of it down and have to be
maintained as soon as possible.
Such response will have 500 (Internal Error) http status code
{
'message': 'Internal Error',
'status_code': 500
}
Translations
To get all available translation for key use param with_translation=1 in path.
For example:
/resources/field-permissions?with_translations=1:
{
'data': [
{
'id': 3,
'alias': 'edit',
'name': {
'en': 'Edit',
'fr': 'Modifier'
}
},
//....
]
}
/resources/field-permissions:
{
'data': [
{
'id': 3,
'alias': 'edit',
'name': 'Edit',
},
//....
]
}
Status
In Progress.
Actions ¶
Actions it is a way to interact with users and provide them tasks that need to be completed.
Actions ¶
Action categories
See GET /resources/action-types API
Every action has a type. Action types also grouped by categories. So we may apply specific processing to actions based on categories and types.
For now we have following categories:
-
form. Types are:
form_assignment -
validation. Types are:
expense,recruiting,leave -
link. Types are:
link -
todo. Types are:
todo,certificate -
schedule. Types are:
schedule
Action types
-
form_assignmentKind of reminder to fill specific assignment. Will have assignment details in payload property. -
linkAction with a link to external URL (resource). No specific processing -
todo,scheduleKind of task that user need to complete. Applies specific handling -
certificate,expense,recruitingKind of reminder. No specific processing -
leaveValidation action that applies specific processing
Action Processing
form_assignment
Should be used to give user a way to complete assignment. Payload will provide additional details to perform an API call to get form assignment
Payload structure:
-
user_idinteger, required. ID of user that assignment originally assigned to. It can be different from action user because of workflow. The user from payload always points on user form originally assigned to -
form_instance_idinteger, required. ID of form assignment that user need to complete -
mass_edit- boolean, required. Shows if the assignment supports mass edit feature or not -
stepstring, required. The current workflow step that need to be complete
link
No specific processing
todo, schedule
Allows to mark it as done or rejected. If rejected user need to put a comment. See PATCH /actions API
certificate,expense, recruiting
No specific processing
leave
Validation action that applies specific processing and used to syncronize leave requests with external tool.
Payload structure:
-
external_idstring. Action ID from external tool. Used during synchronization to match the action in external tool -
provider_namestring. Used during synchronization -
company_namestring. Used during synchronization -
approver_idstring. Used during synchronization. Represents the person that need to confirm the leave request
Actions created by system
In some cases to organize the process and to help users to interact with system it can create and assign actions automatically (based on internal rules and state)
New Form Assignment created
When new assignment created it will create an action with assignment target user as action assignee. Assignment creator will be used as action author. Form name will be used as action title. Hardcoded message will be used as subtitle. Lifetime will be 100 years (almost eternity)
Form Assignment progressed to next user in workflow
When assignment has workflow and the current step completed (data was submitted). It will create an action for the user that need to handle next step. Old actions will be completed (closed) It wIll create create an action with assignment target user as target. Assignment creator will be used as action author. Form name will be used as action title. Hardcoded message will be used as subtitle. Lifetime will be 100 years (almost eternity)
ListGET/actions{?user-id,effective-after,effective-before,expires_after,expires_before,type-alias,statuses,actual,page,per-page,no-pagination}
Get list of actions matches specified filters
To view list of actions user must have actions.view permission
Example URI
- user-id
number(required) Example: 123- effective-after
date-time(required) Example: 2019-03-21 09:34:58- effective-before
date-time(required) Example: 2019-03-21 09:34:58- expires_after
date-time(required) Example: 2019-03-21 09:34:58- expires_before
date-time(required) Example: 2019-03-21 09:34:58- type-alias
string(required) Example: leave- statuses
array[string](required)-
new
-
active
-
approved
-
pending
-
done
-
failed
-
rejected
-
- actual
boolean(required) Example: truePredefined set of filter. Same as
effective-before=<now>&statuses[]=active&statuses[]=pending- page
number(required) Example: 1Page number.
1by default- per-page
number(required) Example: 10Number of items per page,
25by default- no-pagination
boolean(required) Example: falseif presented and positive pagination will not be applied. All available items will be returned.
Note: it may have significant impact on the performance
Note: once this option positive and presented -
metaattribute with pagination data will be omit in response
Headers
Accept: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target permission>200Headers
Content-Type: application/jsonBody
{
"data": [
{
"id": 123,
"author": {
"id": 1,
"external_id": 1,
"first_name": "John",
"last_name": "Snow",
"username": "john_snow",
"professional_email": "jsnow@example.com",
"professional_mobile_phone": "00 33 1 40 00 00 00",
"professional_phone": "00 33 1 40 00 00 00",
"role": [
"bastard",
"king"
],
"is_active": true,
"status": "remote",
"settings": [
"[]"
],
"user_photo": "http://example.com/images/1.jpg"
},
"title": "Medical Visit",
"subtitle": "You need to visit a doctor",
"details": "Some more info",
"type": {
"id": 34,
"name": "Leave Request",
"alias": "leave",
"category": "validation"
},
"link": "http://example.com",
"status": "active",
"payload": {},
"icon": "http://example.com/image.png",
"effective_date": "2019-01-24 15:34:58",
"expires_at": "2019-03-21 09:34:58",
"created_at": "2019-01-24 12:23:00",
"updated_at": "2019-01-25 03:12:43"
}
],
"meta": {
"pagination": {
"total": 238,
"count": 25,
"per_page": 25,
"current_page": 2,
"total_pages": 10,
"links": {
"previous": "http://example.com/api/<endpoint>?page=1",
"next": "http://example.com/api/<endpoint>?page=3"
}
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"author": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"external_id": {
"type": "number"
},
"first_name": {
"type": "string"
},
"last_name": {
"type": "string"
},
"username": {
"type": "string"
},
"professional_email": {
"type": "string"
},
"professional_mobile_phone": {
"type": "string"
},
"professional_phone": {
"type": "string"
},
"role": {
"type": "array"
},
"is_active": {
"type": "boolean"
},
"status": {
"type": "string"
},
"settings": {
"type": "array"
},
"user_photo": {
"type": "string"
}
},
"required": [
"id",
"external_id",
"first_name",
"last_name",
"username",
"professional_email",
"professional_mobile_phone",
"professional_phone",
"role",
"is_active",
"status",
"settings",
"user_photo"
]
},
"title": {
"type": "string"
},
"subtitle": {
"type": "string"
},
"details": {
"type": "string"
},
"type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"category": {
"type": "string"
}
},
"required": [
"id",
"name",
"alias",
"category"
],
"additionalProperties": false
},
"link": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"new",
"active",
"approved",
"pending",
"done",
"failed",
"rejected"
]
},
"payload": {
"type": "object",
"properties": {}
},
"icon": {
"type": "string"
},
"effective_date": {
"type": "string"
},
"expires_at": {
"type": "string"
},
"created_at": {
"type": "string"
},
"updated_at": {
"type": "string"
}
},
"required": [
"id",
"author",
"title",
"status",
"effective_date",
"expires_at",
"created_at",
"updated_at"
]
}
},
"meta": {
"type": "object",
"properties": {
"pagination": {
"type": "object",
"properties": {
"total": {
"type": "number"
},
"count": {
"type": "number"
},
"per_page": {
"type": "number"
},
"current_page": {
"type": "number"
},
"total_pages": {
"type": "number"
},
"links": {
"type": "object",
"properties": {
"previous": {
"type": "string"
},
"next": {
"type": "string"
}
},
"required": [
"previous",
"next"
]
}
},
"required": [
"total",
"count",
"per_page",
"current_page",
"total_pages",
"links"
],
"additionalProperties": false
}
},
"required": [
"pagination"
]
}
}
}401Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 401
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}403Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 403
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}404Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 404
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}406Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 406
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}422Headers
Content-Type: application/jsonBody
{
"message": "Descriptive error message",
"status_code": 422,
"errors": [
"Error message"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
},
"errors": {
"type": "array"
}
}
}500Headers
Content-Type: application/jsonBody
{
"message": "Internal Error",
"status_code": 500
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}ShowGET/actions/{id}
Get details for specified action
To get action details user must have actions.view.* permissions
Example URI
- id
number(required) Example: 1267ID of the action
Headers
Accept: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target permission>200Headers
Content-Type: application/jsonBody
{
"data": {
"id": 123,
"author": {
"id": 1,
"external_id": 1,
"first_name": "John",
"last_name": "Snow",
"username": "john_snow",
"professional_email": "jsnow@example.com",
"professional_mobile_phone": "00 33 1 40 00 00 00",
"professional_phone": "00 33 1 40 00 00 00",
"role": [
"bastard",
"king"
],
"is_active": true,
"status": "remote",
"settings": [
"[]"
],
"user_photo": "http://example.com/images/1.jpg"
},
"title": "Medical Visit",
"subtitle": "You need to visit a doctor",
"details": "Some more info",
"type": {
"id": 34,
"name": "Leave Request",
"alias": "leave",
"category": "validation"
},
"link": "http://example.com",
"status": "active",
"payload": {},
"icon": "http://example.com/image.png",
"effective_date": "2019-01-24 15:34:58",
"expires_at": "2019-03-21 09:34:58",
"created_at": "2019-01-24 12:23:00",
"updated_at": "2019-01-25 03:12:43"
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"author": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"external_id": {
"type": "number"
},
"first_name": {
"type": "string"
},
"last_name": {
"type": "string"
},
"username": {
"type": "string"
},
"professional_email": {
"type": "string"
},
"professional_mobile_phone": {
"type": "string"
},
"professional_phone": {
"type": "string"
},
"role": {
"type": "array"
},
"is_active": {
"type": "boolean"
},
"status": {
"type": "string"
},
"settings": {
"type": "array"
},
"user_photo": {
"type": "string"
}
},
"required": [
"id",
"external_id",
"first_name",
"last_name",
"username",
"professional_email",
"professional_mobile_phone",
"professional_phone",
"role",
"is_active",
"status",
"settings",
"user_photo"
]
},
"title": {
"type": "string"
},
"subtitle": {
"type": "string"
},
"details": {
"type": "string"
},
"type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"category": {
"type": "string"
}
},
"required": [
"id",
"name",
"alias",
"category"
],
"additionalProperties": false
},
"link": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"new",
"active",
"approved",
"pending",
"done",
"failed",
"rejected"
]
},
"payload": {
"type": "object",
"properties": {}
},
"icon": {
"type": "string"
},
"effective_date": {
"type": "string"
},
"expires_at": {
"type": "string"
},
"created_at": {
"type": "string"
},
"updated_at": {
"type": "string"
}
},
"required": [
"id",
"author",
"title",
"status",
"effective_date",
"expires_at",
"created_at",
"updated_at"
]
}
}
}401Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 401
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}403Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 403
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}404Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 404
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}406Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 406
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}422Headers
Content-Type: application/jsonBody
{
"message": "Descriptive error message",
"status_code": 422,
"errors": [
"Error message"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
},
"errors": {
"type": "array"
}
}
}500Headers
Content-Type: application/jsonBody
{
"message": "Internal Error",
"status_code": 500
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}CountGET/actions/count{?user-id,effective-after,effective-before,expires_after,expires_before,type-alias,statuses,actual,page,per-page,no-pagination}
Get count of actions matches specified filters
To view number of actions user must have actions.view permission
Example URI
- user-id
number(required) Example: 123- effective-after
date-time(required) Example: 2019-03-21 09:34:58- effective-before
date-time(required) Example: 2019-03-21 09:34:58- expires_after
date-time(required) Example: 2019-03-21 09:34:58- expires_before
date-time(required) Example: 2019-03-21 09:34:58- type-alias
string(required) Example: leave- statuses
array[string](required)-
new
-
active
-
approved
-
pending
-
done
-
failed
-
rejected
-
- actual
boolean(required) Example: truePredefined set of filter. Same as
effective-before=<now>&statuses[]=active&statuses[]=pending- page
number(required) Example: 1Page number.
1by default- per-page
number(required) Example: 10Number of items per page,
25by default- no-pagination
boolean(required) Example: falseif presented and positive pagination will not be applied. All available items will be returned.
Note: it may have significant impact on the performance
Note: once this option positive and presented -
metaattribute with pagination data will be omit in response
Headers
Accept: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target permission>200Headers
Content-Type: application/jsonBody
{
"data": {
"count": 34
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"count": {
"type": "number"
}
},
"required": [
"count"
],
"additionalProperties": false
}
}
}401Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 401
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}403Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 403
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}404Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 404
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}406Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 406
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}422Headers
Content-Type: application/jsonBody
{
"message": "Descriptive error message",
"status_code": 422,
"errors": [
"Error message"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
},
"errors": {
"type": "array"
}
}
}500Headers
Content-Type: application/jsonBody
{
"message": "Internal Error",
"status_code": 500
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}CreatePOST/actions
Create new action
To create action user must have one of specific permissions:
-
actions.create.*- allows to create any type of actions -
actions.create.todo- allows to create onlytodoactions -
actions.create.schedule- allows to create onlyscheduleactions
Action population
Population is array of different populations. Each kind of population item defined by type property. Available types:
-
all (all active PSOs of given type - see pso_type in main section)
-
group (specified groups)
-
pso (specific PSOs)
-
relation (user or alias of field with relation type)
Population items can be combined. So in population array we may have few entries with different types
Examples: For all type:
[
{
"type": "all",
"details": null
}
]
For group type:
[
{
"type": "group",
"details": {
"dynamic": true,
"includes": ["group_a", "group_b"],
"excludes": ["group_c", "group_d"]
}
}
]
For pso type:
[
{
"type": "pso",
"details": [123, 456]
}
]
For relation type:
[
{
"type": "relation",
"details": [
"user",
"manager",
"..."
]
}
]
Mixed types:
[
{
"type": "group",
"details": {
"dynamic": true,
"includes": ["group_a", "group_b"],
"excludes": ["group_c", "group_d"]
}
},
{
"type": "pso",
"details": [123, 456]
},
{
"type": "relation",
"details": [
"self",
"manager",
"..."
]
}
]
Action substitutions
Substitutions is an array of variables that presented in title, subtitle and details fields. And used to replace these variables in the text to data from Action recipients (they described at Population section).
In this case only {$<field_alias>} syntax supported, because this route doesn’t support any conditions.
Example:
[
"{$usr_first_name}",
"{$usr_last_name}"
]
warning Substitutions supports only in create request.
Example URI
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>Body
{
"author_id": 123,
"title": {
"en": "Some text",
"fr": "Du texte",
"de": "Setwas Text",
"es": "Algún texto"
},
"subtitle": {
"en": "Some text",
"fr": "Du texte",
"de": "Setwas Text",
"es": "Algún texto"
},
"details": {
"en": "Some text",
"fr": "Du texte",
"de": "Setwas Text",
"es": "Algún texto"
},
"type_id": 45,
"link": "http://example.com",
"status": "active",
"icon": "http://example.com/image.png",
"relation": "usr_custom_manager",
"payload": {},
"effective_date": "2019-01-24 15:34:58",
"expires_at": "2019-03-21 09:34:58",
"population": [
{
"type": "group",
"details": {
"dynamic": false,
"includes": [
"group_a"
],
"excludes": [
"group_b",
"group_c"
]
}
}
],
"substitutions": [
"{$usr_first_name}",
"{$usr_last_name}"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"author_id": {
"type": "number",
"description": "only Super Admin can specify it. It will use currently authorized user instead"
},
"title": {
"type": "object",
"properties": {
"en": {
"type": "string"
},
"fr": {
"type": "string"
},
"de": {
"type": "string"
},
"es": {
"type": "string"
}
},
"required": [
"en",
"fr",
"de",
"es"
],
"additionalProperties": false
},
"subtitle": {
"type": "object",
"properties": {
"en": {
"type": "string"
},
"fr": {
"type": "string"
},
"de": {
"type": "string"
},
"es": {
"type": "string"
}
},
"required": [
"en",
"fr",
"de",
"es"
]
},
"details": {
"type": "object",
"properties": {
"en": {
"type": "string"
},
"fr": {
"type": "string"
},
"de": {
"type": "string"
},
"es": {
"type": "string"
}
},
"required": [
"en",
"fr",
"de",
"es"
]
},
"type_id": {
"type": "number"
},
"link": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"new",
"active",
"approved",
"pending",
"done",
"failed",
"rejected"
]
},
"icon": {
"type": "string"
},
"relation": {
"type": "string",
"description": "if presented action will be created for the PSO mentioned as specified relation for `user_id` "
},
"payload": {
"type": "object",
"properties": {}
},
"effective_date": {
"type": "string"
},
"expires_at": {
"type": "string"
},
"population": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"all",
"group",
"pso",
"relation"
]
},
"details": {
"anyOf": [
{
"type": "object",
"properties": {
"dynamic": {
"type": "boolean"
},
"includes": {
"type": "array"
},
"excludes": {
"type": "array"
}
},
"required": [
"dynamic",
"includes",
"excludes"
]
},
{
"type": "array",
"enum": [
[],
[]
]
}
],
"type": "null"
}
},
"required": [
"type",
"details"
]
}
},
"substitutions": {
"type": "array"
}
},
"required": [
"type_id",
"status",
"effective_date",
"expires_at"
]
}201Headers
Content-Type: application/jsonBody
{
"data": {
"id": 123,
"alias": "can_be_null"
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"alias": {
"type": "string"
}
},
"required": [
"id"
],
"additionalProperties": false
}
}
}400Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 400
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}401Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 401
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}403Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 403
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}404Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 404
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}406Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 406
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}422Headers
Content-Type: application/jsonBody
{
"message": "Descriptive error message",
"status_code": 422,
"errors": [
"Error message"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
},
"errors": {
"type": "array"
}
}
}500Headers
Content-Type: application/jsonBody
{
"message": "Internal Error",
"status_code": 500
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}UpdatePATCH/actions/{id}
Update the action
To update the action user must have actions.update.* permissions
[DEPRECATED] Approving/rejecting actions
Some action types (schedule for example) requires additional actions to be done on Approve/Reject Be sure to use Approve or Reject endpoints to perform this operation
Approval and rejection through PATCH API is deprecated and will be forbidden in next versions
Approve means changing status property to approved
Reject means changing status property to rejected
Actions that belongs to the validation category (see type.category property) must be validated.
Validation means Approve or Reject
In addition to changing status user may leave a comment (comment property) with some details.
This text will be used on notification that will be sent to the action creator
Please note: on action Approve comment is optional, but it is required on Reject
Example URI
- id
number(required) Example: 1267ID of the action to be updated
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>Body
{
"title": {
"en": "Some text",
"fr": "Du texte",
"de": "Setwas Text",
"es": "Algún texto"
},
"subtitle": {
"en": "Some text",
"fr": "Du texte",
"de": "Setwas Text",
"es": "Algún texto"
},
"details": {
"en": "Some text",
"fr": "Du texte",
"de": "Setwas Text",
"es": "Algún texto"
},
"type_id": 45,
"link": "http://example.com",
"status": "active",
"icon": "http://example.com/image.png",
"payload": {},
"effective_date": "2019-01-24 15:34:58",
"expires_at": "2019-03-21 09:34:58"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"title": {
"type": "object",
"properties": {
"en": {
"type": "string"
},
"fr": {
"type": "string"
},
"de": {
"type": "string"
},
"es": {
"type": "string"
}
},
"required": [
"en",
"fr",
"de",
"es"
]
},
"subtitle": {
"type": "object",
"properties": {
"en": {
"type": "string"
},
"fr": {
"type": "string"
},
"de": {
"type": "string"
},
"es": {
"type": "string"
}
},
"required": [
"en",
"fr",
"de",
"es"
]
},
"details": {
"type": "object",
"properties": {
"en": {
"type": "string"
},
"fr": {
"type": "string"
},
"de": {
"type": "string"
},
"es": {
"type": "string"
}
},
"required": [
"en",
"fr",
"de",
"es"
]
},
"type_id": {
"type": "number"
},
"link": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"new",
"active",
"approved",
"pending",
"done",
"failed",
"rejected"
]
},
"icon": {
"type": "string"
},
"payload": {
"type": "object",
"properties": {}
},
"effective_date": {
"type": "string"
},
"expires_at": {
"type": "string"
}
}
}200Headers
Content-Type: application/json400Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 400
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}401Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 401
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}403Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 403
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}404Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 404
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}406Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 406
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}422Headers
Content-Type: application/jsonBody
{
"message": "Descriptive error message",
"status_code": 422,
"errors": [
"Error message"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
},
"errors": {
"type": "array"
}
}
}500Headers
Content-Type: application/jsonBody
{
"message": "Internal Error",
"status_code": 500
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}Approve actionPOST/actions/{id}/approve
To approve the action user must have actions.update.* permissions
Approve means changing status property to approved. It may also apply additional actions that depends on the action type
Actions that belongs to the validation category (see type.category property) must be validated (approved or rejected).
Note: This endpoint will not apply any changes for actions that do not belongs to validation category
Example URI
- id
number(required) Example: 1267ID of the action to be updated
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>Body
{
"comment": "Any free text",
"scheduled_at": "2019-03-21 09:34:58"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"comment": {
"type": "string"
},
"scheduled_at": {
"type": "string",
"description": "has sense only for actions with `schedule` type"
}
}
}202Headers
Content-Type: application/json400Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 400
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}401Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 401
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}403Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 403
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}404Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 404
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}406Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 406
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}422Headers
Content-Type: application/jsonBody
{
"message": "Descriptive error message",
"status_code": 422,
"errors": [
"Error message"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
},
"errors": {
"type": "array"
}
}
}500Headers
Content-Type: application/jsonBody
{
"message": "Internal Error",
"status_code": 500
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}Reject actionPOST/actions/{id}/reject
To reject the action user must have actions.update.* permissions
Reject means changing status property to rejected
Actions that belongs to the validation category (see type.category property) must be validated (approved or rejected)
Note: This endpoint will not apply any changes for actions that do not belongs to validation category
Example URI
- id
number(required) Example: 1267ID of the action to be updated
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>Body
{
"comment": "Any free text"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"comment": {
"type": "string"
}
}
}200Headers
Content-Type: application/json400Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 400
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}401Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 401
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}403Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 403
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}404Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 404
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}406Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 406
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}422Headers
Content-Type: application/jsonBody
{
"message": "Descriptive error message",
"status_code": 422,
"errors": [
"Error message"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
},
"errors": {
"type": "array"
}
}
}500Headers
Content-Type: application/jsonBody
{
"message": "Internal Error",
"status_code": 500
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}DeleteDELETE/actions/{id}
Remove the action
Example URI
- id
number(required) Example: 1267ID of the action to be removed
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>204Headers
Content-Type: application/json400Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 400
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}401Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 401
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}403Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 403
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}404Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 404
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}406Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 406
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}422Headers
Content-Type: application/jsonBody
{
"message": "Descriptive error message",
"status_code": 422,
"errors": [
"Error message"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
},
"errors": {
"type": "array"
}
}
}500Headers
Content-Type: application/jsonBody
{
"message": "Internal Error",
"status_code": 500
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}Assignment Data ¶
Assignment Data is a common name for all concrete form assignments. It related to the Form Assignment (Form Instance) and to the Data Owner (PSO that assignment assigned to)
Assignment Data ¶
SubmitPOST/psos/{dataOwner}/form-instances/{formInstance}
Submit Form Data for specified formInstance that assigned to the dataOwner.
Example URI
- dataOwner
number(required) Example: 5Id of PSO Form Assignment assigned to.
- formInstance
number(required) Example: 312Id of Form Assignment data related to.
Headers
Accept: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target permission>202Headers
Content-Type: application/json401Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 401
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}403Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 403
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}404Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 404
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}406Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 406
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}422Headers
Content-Type: application/jsonBody
{
"message": "Descriptive error message",
"status_code": 422,
"errors": [
"Error message"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
},
"errors": {
"type": "array"
}
}
}500Headers
Content-Type: application/jsonBody
{
"message": "Internal Error",
"status_code": 500
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}ShowGET/psos/{dataOwner}/form-instances/{formInstance}{?include}
Get Form Data for specified formInstance that assigned to the dataOwner
Example URI
- dataOwner
number(required) Example: 5Id of PSO Form Assignment assigned to.
- formInstance
number(required) Example: 123Id of Form Assignment data related to.
- include
string(optional) Example: fields.type,settingsComma separated list of related resources that will be included into response.
Possible values:
-
settings
-
fields
-
fields.type
-
fields.category
-
fields.category.pso_type
-
fields.domains
-
fields.domains.pso_type
-
fields.privacy_level
-
fields.pso_type
-
fields.items
-
fields.options
-
fields.settings
-
fields.assignment_settings
-
fields.assignment_permissions
Note that includes uses kind of inheritance. So if you put
include=fields.items.typeit will also populateitemsproperty for all fieldsIf you need to dive into and include related resources for sub-items you can use same options that
fieldsproperty has.For example:
include=fields.items.typewill attach to the response all fields that assignment has.
Every includedfieldwill haveitemsproperty populated. Every item initemsproperty will havetypeproperty populated-
Headers
Accept: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target permission>200Note: response example provides all nested data, but in fact it depends on include option
Headers
Content-Type: application/jsonBody
{
"data": {
"id": 1,
"name": "Assignment Name",
"description": "Assignment Description",
"form_id": 1,
"is_active": true,
"removable": true,
"can_edit": true,
"effective_date": "2019-01-01 23:34:40",
"approval_scheduled_date": "2019-01-01 23:34:40",
"fields": [
{
"id": 1,
"name": "Field Name",
"position": 5,
"alias": "usr_first_name",
"has_unique_data": false,
"has_value": true,
"removable": false,
"is_active": true,
"list": false,
"read_only": false,
"required": true,
"type": {
"id": 1,
"name": "Data Type Name",
"alias": "data_type_alias",
"settings": [
{
"id": 1,
"name": "Data Type Setting Name",
"alias": "data_type_setting_alias",
"is_required": true
}
],
"supports_collection": false,
"supports_read_only": false,
"supports_unique": false
},
"category": {
"id": 32,
"alias": "usr_identity",
"position": 5,
"system_required": true,
"name": "Identity",
"description": "...",
"is_active": true,
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
}
},
"domains": [
{
"id": 46,
"alias": "usr_global",
"name": "User Global",
"description": "...",
"is_editable": false,
"is_removable": false,
"is_active": true,
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
}
}
],
"privacy_level": {
"id": 123,
"alias": "public",
"name": "Not Sensitive",
"level": 100
},
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
},
"items": [
{
"id": 1,
"name": "Field Name",
"position": 5,
"alias": "usr_first_name",
"has_unique_data": false,
"has_value": true,
"removable": false,
"is_active": true,
"list": false,
"read_only": false,
"required": true,
"type": {
"id": 1,
"name": "Data Type Name",
"alias": "data_type_alias",
"settings": [
{
"id": 1,
"name": "Data Type Setting Name",
"alias": "data_type_setting_alias",
"is_required": true
}
],
"supports_collection": false,
"supports_read_only": false,
"supports_unique": false
},
"category": {
"id": 32,
"alias": "usr_identity",
"position": 5,
"system_required": true,
"name": "Identity",
"description": "...",
"is_active": true,
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
}
},
"domains": [
{
"id": 46,
"alias": "usr_global",
"name": "User Global",
"description": "...",
"is_editable": false,
"is_removable": false,
"is_active": true,
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
}
}
],
"privacy_level": {
"id": 123,
"alias": "public",
"name": "Not Sensitive",
"level": 100
},
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
},
"items": [
{}
],
"options": [
{
"id": 198,
"name": "Chose me!",
"position": 9,
"value": "198",
"is_active": true
}
],
"settings": []
}
],
"options": [
{
"id": 198,
"name": "Chose me!",
"position": 9,
"value": "198",
"is_active": true
}
],
"settings": [],
"is_locked": true,
"values": "123",
"value_details": "",
"values_count": 1,
"assignment_settings": [],
"assignment_permissions": [],
"access_permissions": []
}
],
"settings": [
{
"id": 456,
"form_instance_id": 1,
"setting_id": 123,
"value": "some value"
}
]
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"form_id": {
"type": "number"
},
"is_active": {
"type": "boolean"
},
"removable": {
"type": "boolean"
},
"can_edit": {
"type": "boolean"
},
"effective_date": {
"type": "string"
},
"approval_scheduled_date": {
"type": "string"
},
"fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"position": {
"type": "number"
},
"alias": {
"type": "string"
},
"has_unique_data": {
"type": "boolean",
"description": "whether field requires values to be unique across system"
},
"has_value": {
"type": "boolean",
"description": "whether field has at least one value submitted"
},
"removable": {
"type": "boolean",
"description": "whether field can be removed from system"
},
"is_active": {
"type": "boolean"
},
"list": {
"type": "boolean",
"description": "whether field can handle collection of values"
},
"read_only": {
"type": "boolean",
"description": "whether field value can be changed"
},
"required": {
"type": "boolean",
"description": "whether field value required by system"
},
"type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"settings": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"is_required": {
"type": "boolean"
}
},
"required": [
"id",
"name",
"alias",
"is_required"
]
}
},
"supports_collection": {
"type": "boolean"
},
"supports_read_only": {
"type": "boolean"
},
"supports_unique": {
"type": "boolean"
}
},
"required": [
"id",
"name",
"alias",
"settings",
"supports_collection",
"supports_read_only",
"supports_unique"
],
"additionalProperties": false
},
"category": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"alias": {
"type": "string"
},
"position": {
"type": "number"
},
"system_required": {
"type": "boolean"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"pso_type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"system_required": {
"type": "boolean"
},
"creation_form_instance_id": {
"type": "number"
},
"profile_form_instance_id": {
"type": "number"
}
},
"required": [
"id",
"name",
"alias",
"description",
"is_active",
"system_required",
"creation_form_instance_id",
"profile_form_instance_id"
],
"additionalProperties": false
}
},
"required": [
"id",
"alias",
"position",
"system_required",
"name",
"description",
"is_active"
],
"additionalProperties": false
},
"domains": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"alias": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"is_editable": {
"type": "boolean"
},
"is_removable": {
"type": "boolean"
},
"is_active": {
"type": "boolean"
},
"pso_type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"system_required": {
"type": "boolean"
},
"creation_form_instance_id": {
"type": "number"
},
"profile_form_instance_id": {
"type": "number"
}
},
"required": [
"id",
"name",
"alias",
"description",
"is_active",
"system_required",
"creation_form_instance_id",
"profile_form_instance_id"
],
"additionalProperties": false
}
},
"required": [
"id",
"alias",
"name",
"description",
"is_editable",
"is_removable",
"is_active"
]
}
},
"privacy_level": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"alias": {
"type": "string"
},
"name": {
"type": "string"
},
"level": {
"type": "number"
}
},
"required": [
"id",
"alias",
"name",
"level"
],
"additionalProperties": false
},
"pso_type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"system_required": {
"type": "boolean"
},
"creation_form_instance_id": {
"type": "number"
},
"profile_form_instance_id": {
"type": "number"
}
},
"required": [
"id",
"name",
"alias",
"description",
"is_active",
"system_required",
"creation_form_instance_id",
"profile_form_instance_id"
],
"additionalProperties": false
},
"items": {
"type": [
"array",
"null"
],
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"position": {
"type": "number"
},
"alias": {
"type": "string"
},
"has_unique_data": {
"type": "boolean",
"description": "whether field requires values to be unique across system"
},
"has_value": {
"type": "boolean",
"description": "whether field has at least one value submitted"
},
"removable": {
"type": "boolean",
"description": "whether field can be removed from system"
},
"is_active": {
"type": "boolean"
},
"list": {
"type": "boolean",
"description": "whether field can handle collection of values"
},
"read_only": {
"type": "boolean",
"description": "whether field value can be changed"
},
"required": {
"type": "boolean",
"description": "whether field value required by system"
},
"type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"settings": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"is_required": {
"type": "boolean"
}
},
"required": [
"id",
"name",
"alias",
"is_required"
]
}
},
"supports_collection": {
"type": "boolean"
},
"supports_read_only": {
"type": "boolean"
},
"supports_unique": {
"type": "boolean"
}
},
"required": [
"id",
"name",
"alias",
"settings",
"supports_collection",
"supports_read_only",
"supports_unique"
],
"additionalProperties": false
},
"category": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"alias": {
"type": "string"
},
"position": {
"type": "number"
},
"system_required": {
"type": "boolean"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"pso_type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"system_required": {
"type": "boolean"
},
"creation_form_instance_id": {
"type": "number"
},
"profile_form_instance_id": {
"type": "number"
}
},
"required": [
"id",
"name",
"alias",
"description",
"is_active",
"system_required",
"creation_form_instance_id",
"profile_form_instance_id"
],
"additionalProperties": false
}
},
"required": [
"id",
"alias",
"position",
"system_required",
"name",
"description",
"is_active"
],
"additionalProperties": false
},
"domains": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"alias": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"is_editable": {
"type": "boolean"
},
"is_removable": {
"type": "boolean"
},
"is_active": {
"type": "boolean"
},
"pso_type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"system_required": {
"type": "boolean"
},
"creation_form_instance_id": {
"type": "number"
},
"profile_form_instance_id": {
"type": "number"
}
},
"required": [
"id",
"name",
"alias",
"description",
"is_active",
"system_required",
"creation_form_instance_id",
"profile_form_instance_id"
],
"additionalProperties": false
}
},
"required": [
"id",
"alias",
"name",
"description",
"is_editable",
"is_removable",
"is_active"
]
}
},
"privacy_level": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"alias": {
"type": "string"
},
"name": {
"type": "string"
},
"level": {
"type": "number"
}
},
"required": [
"id",
"alias",
"name",
"level"
],
"additionalProperties": false
},
"pso_type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"system_required": {
"type": "boolean"
},
"creation_form_instance_id": {
"type": "number"
},
"profile_form_instance_id": {
"type": "number"
}
},
"required": [
"id",
"name",
"alias",
"description",
"is_active",
"system_required",
"creation_form_instance_id",
"profile_form_instance_id"
],
"additionalProperties": false
},
"items": {
"type": [
"array",
"null"
],
"items": {
"type": "object",
"properties": {}
}
},
"options": {
"type": [
"array",
"null"
],
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"position": {
"type": "number"
},
"value": {
"type": "string"
},
"is_active": {
"type": "boolean"
}
},
"required": [
"id",
"name",
"position",
"value",
"is_active"
]
},
"description": "List of options with possible (allowed) values."
},
"settings": {
"type": "array",
"items": {
"type": "string"
},
"description": "Common field settings"
}
},
"required": [
"id",
"name",
"position",
"alias",
"has_unique_data",
"has_value",
"removable",
"is_active",
"list",
"read_only",
"required"
]
}
},
"options": {
"type": [
"array",
"null"
],
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"position": {
"type": "number"
},
"value": {
"type": "string"
},
"is_active": {
"type": "boolean"
}
},
"required": [
"id",
"name",
"position",
"value",
"is_active"
]
},
"description": "List of options with possible (allowed) values."
},
"settings": {
"type": "array",
"items": {
"type": "string"
},
"description": "Common field settings"
},
"is_locked": {
"type": "boolean"
},
"values": {
"type": "string"
},
"value_details": {
"type": [
"string",
"null"
],
"description": "user friendly value representation. Actual structure depends on field type"
},
"values_count": {
"type": "number",
"description": "number of values field has for current user. Meaningful only when `list` is true"
},
"assignment_settings": {
"type": "array",
"items": {
"type": "string"
},
"description": "Settings related to this specific Field and Form"
},
"assignment_permissions": {
"type": "array",
"items": {
"type": "string"
},
"description": "Permissions related to this specific Field and Form"
},
"access_permissions": {
"type": "array",
"items": {
"type": "string"
},
"description": "Access permissions specific for current user"
}
},
"required": [
"id",
"name",
"position",
"alias",
"has_unique_data",
"has_value",
"removable",
"is_active",
"list",
"read_only",
"required",
"values",
"value_details",
"values_count",
"access_permissions"
]
}
},
"settings": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"form_instance_id": {
"type": "number"
},
"setting_id": {
"type": "number"
},
"value": {
"type": "string"
}
}
}
}
},
"required": [
"name",
"description",
"form_id",
"is_active",
"removable",
"can_edit"
]
}
}
}401Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 401
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}403Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 403
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}404Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 404
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}406Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 406
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}422Headers
Content-Type: application/jsonBody
{
"message": "Descriptive error message",
"status_code": 422,
"errors": [
"Error message"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
},
"errors": {
"type": "array"
}
}
}500Headers
Content-Type: application/jsonBody
{
"message": "Internal Error",
"status_code": 500
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}Mass Edit ¶
SubmitPOST/form-instances/{formInstance}/{relation}/mass-edit
Submit Form Data for specified formInstance that assigned to the relation
Example URI
- formInstance
number(required) Example: 123Id of Form Assignment data related to.
- relation
string(required) Example: hrStep relation.
Headers
Accept: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target permission>202Headers
Content-Type: application/json401Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 401
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}403Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 403
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}404Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 404
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}406Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 406
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}422Headers
Content-Type: application/jsonBody
{
"message": "Descriptive error message",
"status_code": 422,
"errors": [
"Error message"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
},
"errors": {
"type": "array"
}
}
}500Headers
Content-Type: application/jsonBody
{
"message": "Internal Error",
"status_code": 500
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}ShowGET/form-instances/{formInstance}/{relation}/mass-edit{?include}
Get Form Data for specified formInstance that assigned to the relation
Example URI
- formInstance
number(required) Example: 123Id of Form Assignment data related to.
- relation
string(required) Example: hrStep relation.
- include
string(optional) Example: form_instance.fields.type,settingsComma separated list of related resources that will be included into response.
Possible values:
-
form_instance.settings
-
form_instance.fields
-
form_instance.fields.type
-
form_instance.fields.category
-
form_instance.fields.category.pso_type
-
form_instance.fields.domains
-
form_instance.fields.domains.pso_type
-
form_instance.fields.privacy_level
-
form_instance.fields.pso_type
-
form_instance.fields.items
-
form_instance.fields.options
-
form_instance.fields.settings
-
form_instance.fields.assignment_settings
-
form_instance.fields.assignment_permissions
Note that includes uses kind of inheritance. So if you put
include=form_instance.fields.items.typeit will also populateitemsproperty for all fieldsIf you need to dive into and include related resources for sub-items you can use same options that
fieldsproperty has.For example:
include=form_instance.ields.items.typewill attach to the response all fields that assignment has.
Every includedfieldwill haveitemsproperty populated. Every item initemsproperty will havetypeproperty populated-
Headers
Accept: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target permission>200Note: response example provides all nested data, but in fact it depends on include option
Headers
Content-Type: application/jsonBody
{
"data": {
"id": 1,
"name": "Assignment Name",
"description": "Assignment Description",
"form_id": 1,
"is_active": true,
"removable": true,
"can_edit": true,
"effective_date": "2019-01-01 23:34:40",
"approval_scheduled_date": "2019-01-01 23:34:40",
"fields": [
{
"id": 1,
"name": "Field Name",
"position": 5,
"alias": "usr_first_name",
"has_unique_data": false,
"has_value": true,
"removable": false,
"is_active": true,
"list": false,
"read_only": false,
"required": true,
"type": {
"id": 1,
"name": "Data Type Name",
"alias": "data_type_alias",
"settings": [
{
"id": 1,
"name": "Data Type Setting Name",
"alias": "data_type_setting_alias",
"is_required": true
}
],
"supports_collection": false,
"supports_read_only": false,
"supports_unique": false
},
"category": {
"id": 32,
"alias": "usr_identity",
"position": 5,
"system_required": true,
"name": "Identity",
"description": "...",
"is_active": true,
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
}
},
"domains": [
{
"id": 46,
"alias": "usr_global",
"name": "User Global",
"description": "...",
"is_editable": false,
"is_removable": false,
"is_active": true,
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
}
}
],
"privacy_level": {
"id": 123,
"alias": "public",
"name": "Not Sensitive",
"level": 100
},
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
},
"items": [
{
"id": 1,
"name": "Field Name",
"position": 5,
"alias": "usr_first_name",
"has_unique_data": false,
"has_value": true,
"removable": false,
"is_active": true,
"list": false,
"read_only": false,
"required": true,
"type": {
"id": 1,
"name": "Data Type Name",
"alias": "data_type_alias",
"settings": [
{
"id": 1,
"name": "Data Type Setting Name",
"alias": "data_type_setting_alias",
"is_required": true
}
],
"supports_collection": false,
"supports_read_only": false,
"supports_unique": false
},
"category": {
"id": 32,
"alias": "usr_identity",
"position": 5,
"system_required": true,
"name": "Identity",
"description": "...",
"is_active": true,
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
}
},
"domains": [
{
"id": 46,
"alias": "usr_global",
"name": "User Global",
"description": "...",
"is_editable": false,
"is_removable": false,
"is_active": true,
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
}
}
],
"privacy_level": {
"id": 123,
"alias": "public",
"name": "Not Sensitive",
"level": 100
},
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
},
"items": [
{}
],
"options": [
{
"id": 198,
"name": "Chose me!",
"position": 9,
"value": "198",
"is_active": true
}
],
"settings": []
}
],
"options": [
{
"id": 198,
"name": "Chose me!",
"position": 9,
"value": "198",
"is_active": true
}
],
"settings": [],
"is_locked": true,
"values": "123",
"value_details": "",
"values_count": 1,
"assignment_settings": [],
"assignment_permissions": [],
"access_permissions": []
}
],
"settings": [
{
"id": 456,
"form_instance_id": 1,
"setting_id": 123,
"value": "some value"
}
]
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"form_id": {
"type": "number"
},
"is_active": {
"type": "boolean"
},
"removable": {
"type": "boolean"
},
"can_edit": {
"type": "boolean"
},
"effective_date": {
"type": "string"
},
"approval_scheduled_date": {
"type": "string"
},
"fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"position": {
"type": "number"
},
"alias": {
"type": "string"
},
"has_unique_data": {
"type": "boolean",
"description": "whether field requires values to be unique across system"
},
"has_value": {
"type": "boolean",
"description": "whether field has at least one value submitted"
},
"removable": {
"type": "boolean",
"description": "whether field can be removed from system"
},
"is_active": {
"type": "boolean"
},
"list": {
"type": "boolean",
"description": "whether field can handle collection of values"
},
"read_only": {
"type": "boolean",
"description": "whether field value can be changed"
},
"required": {
"type": "boolean",
"description": "whether field value required by system"
},
"type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"settings": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"is_required": {
"type": "boolean"
}
},
"required": [
"id",
"name",
"alias",
"is_required"
]
}
},
"supports_collection": {
"type": "boolean"
},
"supports_read_only": {
"type": "boolean"
},
"supports_unique": {
"type": "boolean"
}
},
"required": [
"id",
"name",
"alias",
"settings",
"supports_collection",
"supports_read_only",
"supports_unique"
],
"additionalProperties": false
},
"category": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"alias": {
"type": "string"
},
"position": {
"type": "number"
},
"system_required": {
"type": "boolean"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"pso_type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"system_required": {
"type": "boolean"
},
"creation_form_instance_id": {
"type": "number"
},
"profile_form_instance_id": {
"type": "number"
}
},
"required": [
"id",
"name",
"alias",
"description",
"is_active",
"system_required",
"creation_form_instance_id",
"profile_form_instance_id"
],
"additionalProperties": false
}
},
"required": [
"id",
"alias",
"position",
"system_required",
"name",
"description",
"is_active"
],
"additionalProperties": false
},
"domains": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"alias": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"is_editable": {
"type": "boolean"
},
"is_removable": {
"type": "boolean"
},
"is_active": {
"type": "boolean"
},
"pso_type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"system_required": {
"type": "boolean"
},
"creation_form_instance_id": {
"type": "number"
},
"profile_form_instance_id": {
"type": "number"
}
},
"required": [
"id",
"name",
"alias",
"description",
"is_active",
"system_required",
"creation_form_instance_id",
"profile_form_instance_id"
],
"additionalProperties": false
}
},
"required": [
"id",
"alias",
"name",
"description",
"is_editable",
"is_removable",
"is_active"
]
}
},
"privacy_level": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"alias": {
"type": "string"
},
"name": {
"type": "string"
},
"level": {
"type": "number"
}
},
"required": [
"id",
"alias",
"name",
"level"
],
"additionalProperties": false
},
"pso_type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"system_required": {
"type": "boolean"
},
"creation_form_instance_id": {
"type": "number"
},
"profile_form_instance_id": {
"type": "number"
}
},
"required": [
"id",
"name",
"alias",
"description",
"is_active",
"system_required",
"creation_form_instance_id",
"profile_form_instance_id"
],
"additionalProperties": false
},
"items": {
"type": [
"array",
"null"
],
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"position": {
"type": "number"
},
"alias": {
"type": "string"
},
"has_unique_data": {
"type": "boolean",
"description": "whether field requires values to be unique across system"
},
"has_value": {
"type": "boolean",
"description": "whether field has at least one value submitted"
},
"removable": {
"type": "boolean",
"description": "whether field can be removed from system"
},
"is_active": {
"type": "boolean"
},
"list": {
"type": "boolean",
"description": "whether field can handle collection of values"
},
"read_only": {
"type": "boolean",
"description": "whether field value can be changed"
},
"required": {
"type": "boolean",
"description": "whether field value required by system"
},
"type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"settings": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"is_required": {
"type": "boolean"
}
},
"required": [
"id",
"name",
"alias",
"is_required"
]
}
},
"supports_collection": {
"type": "boolean"
},
"supports_read_only": {
"type": "boolean"
},
"supports_unique": {
"type": "boolean"
}
},
"required": [
"id",
"name",
"alias",
"settings",
"supports_collection",
"supports_read_only",
"supports_unique"
],
"additionalProperties": false
},
"category": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"alias": {
"type": "string"
},
"position": {
"type": "number"
},
"system_required": {
"type": "boolean"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"pso_type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"system_required": {
"type": "boolean"
},
"creation_form_instance_id": {
"type": "number"
},
"profile_form_instance_id": {
"type": "number"
}
},
"required": [
"id",
"name",
"alias",
"description",
"is_active",
"system_required",
"creation_form_instance_id",
"profile_form_instance_id"
],
"additionalProperties": false
}
},
"required": [
"id",
"alias",
"position",
"system_required",
"name",
"description",
"is_active"
],
"additionalProperties": false
},
"domains": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"alias": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"is_editable": {
"type": "boolean"
},
"is_removable": {
"type": "boolean"
},
"is_active": {
"type": "boolean"
},
"pso_type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"system_required": {
"type": "boolean"
},
"creation_form_instance_id": {
"type": "number"
},
"profile_form_instance_id": {
"type": "number"
}
},
"required": [
"id",
"name",
"alias",
"description",
"is_active",
"system_required",
"creation_form_instance_id",
"profile_form_instance_id"
],
"additionalProperties": false
}
},
"required": [
"id",
"alias",
"name",
"description",
"is_editable",
"is_removable",
"is_active"
]
}
},
"privacy_level": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"alias": {
"type": "string"
},
"name": {
"type": "string"
},
"level": {
"type": "number"
}
},
"required": [
"id",
"alias",
"name",
"level"
],
"additionalProperties": false
},
"pso_type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"system_required": {
"type": "boolean"
},
"creation_form_instance_id": {
"type": "number"
},
"profile_form_instance_id": {
"type": "number"
}
},
"required": [
"id",
"name",
"alias",
"description",
"is_active",
"system_required",
"creation_form_instance_id",
"profile_form_instance_id"
],
"additionalProperties": false
},
"items": {
"type": [
"array",
"null"
],
"items": {
"type": "object",
"properties": {}
}
},
"options": {
"type": [
"array",
"null"
],
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"position": {
"type": "number"
},
"value": {
"type": "string"
},
"is_active": {
"type": "boolean"
}
},
"required": [
"id",
"name",
"position",
"value",
"is_active"
]
},
"description": "List of options with possible (allowed) values."
},
"settings": {
"type": "array",
"items": {
"type": "string"
},
"description": "Common field settings"
}
},
"required": [
"id",
"name",
"position",
"alias",
"has_unique_data",
"has_value",
"removable",
"is_active",
"list",
"read_only",
"required"
]
}
},
"options": {
"type": [
"array",
"null"
],
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"position": {
"type": "number"
},
"value": {
"type": "string"
},
"is_active": {
"type": "boolean"
}
},
"required": [
"id",
"name",
"position",
"value",
"is_active"
]
},
"description": "List of options with possible (allowed) values."
},
"settings": {
"type": "array",
"items": {
"type": "string"
},
"description": "Common field settings"
},
"is_locked": {
"type": "boolean"
},
"values": {
"type": "string"
},
"value_details": {
"type": [
"string",
"null"
],
"description": "user friendly value representation. Actual structure depends on field type"
},
"values_count": {
"type": "number",
"description": "number of values field has for current user. Meaningful only when `list` is true"
},
"assignment_settings": {
"type": "array",
"items": {
"type": "string"
},
"description": "Settings related to this specific Field and Form"
},
"assignment_permissions": {
"type": "array",
"items": {
"type": "string"
},
"description": "Permissions related to this specific Field and Form"
},
"access_permissions": {
"type": "array",
"items": {
"type": "string"
},
"description": "Access permissions specific for current user"
}
},
"required": [
"id",
"name",
"position",
"alias",
"has_unique_data",
"has_value",
"removable",
"is_active",
"list",
"read_only",
"required",
"values",
"value_details",
"values_count",
"access_permissions"
]
}
},
"settings": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"form_instance_id": {
"type": "number"
},
"setting_id": {
"type": "number"
},
"value": {
"type": "string"
}
}
}
}
},
"required": [
"name",
"description",
"form_id",
"is_active",
"removable",
"can_edit"
]
}
}
}401Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 401
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}403Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 403
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}404Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 404
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}406Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 406
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}422Headers
Content-Type: application/jsonBody
{
"message": "Descriptive error message",
"status_code": 422,
"errors": [
"Error message"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
},
"errors": {
"type": "array"
}
}
}500Headers
Content-Type: application/jsonBody
{
"message": "Internal Error",
"status_code": 500
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}Fields Categories ¶
Fields categories.
Fields Categories ¶
ListGET/category{?pso-type,active,search,sort-by,sort-direction}
Fetch list of fields categories
Example URI
- pso-type
number(optional) Example: 123PSO type ID to filtering.
- active
boolean(optional) Example: trueTo filtering fields categories by active state
- search
string(optional) Example: Category to searchSearch by fields categories title. Non strict, case-insensitive.
- sort-by
name, pso-type(optional) Default: name Example: nameField to sort fields categories by.
- sort-direction
asc, desc(optional) Default: asc Example: ascDirection to order fields categories by.
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>200Headers
Content-Type: application/jsonBody
{
"data": [
{
"id": 32,
"alias": "usr_identity",
"position": 5,
"system_required": true,
"name": "Identity",
"description": "...",
"is_active": true,
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
}
}
],
"meta": {
"pagination": {
"total": 238,
"count": 25,
"per_page": 25,
"current_page": 2,
"total_pages": 10,
"links": {
"previous": "http://example.com/api/<endpoint>?page=1",
"next": "http://example.com/api/<endpoint>?page=3"
}
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"alias": {
"type": "string"
},
"position": {
"type": "number"
},
"system_required": {
"type": "boolean"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"pso_type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"system_required": {
"type": "boolean"
},
"creation_form_instance_id": {
"type": "number"
},
"profile_form_instance_id": {
"type": "number"
}
},
"required": [
"id",
"name",
"alias",
"description",
"is_active",
"system_required",
"creation_form_instance_id",
"profile_form_instance_id"
],
"additionalProperties": false
}
},
"required": [
"id",
"alias",
"position",
"system_required",
"name",
"description",
"is_active"
]
}
},
"meta": {
"type": "object",
"properties": {
"pagination": {
"type": "object",
"properties": {
"total": {
"type": "number"
},
"count": {
"type": "number"
},
"per_page": {
"type": "number"
},
"current_page": {
"type": "number"
},
"total_pages": {
"type": "number"
},
"links": {
"type": "object",
"properties": {
"previous": {
"type": "string"
},
"next": {
"type": "string"
}
},
"required": [
"previous",
"next"
]
}
},
"required": [
"total",
"count",
"per_page",
"current_page",
"total_pages",
"links"
],
"additionalProperties": false
}
},
"required": [
"pagination"
]
}
}
}401Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 401
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}403Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 403
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}404Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 404
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}406Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 406
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}422Headers
Content-Type: application/jsonBody
{
"message": "Descriptive error message",
"status_code": 422,
"errors": [
"Error message"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
},
"errors": {
"type": "array"
}
}
}500Headers
Content-Type: application/jsonBody
{
"message": "Internal Error",
"status_code": 500
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}CreatePOST/category
Create new fields category item
Example URI
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>Body
{
"pso_type": "usr",
"name": {
"en": "Some text",
"fr": "Du texte",
"de": "Setwas Text",
"es": "Algún texto"
},
"description": {
"en": "Some text",
"fr": "Du texte",
"de": "Setwas Text",
"es": "Algún texto"
},
"is_active": true,
"alias": "usr_global",
"position": 5,
"is_public": true
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"pso_type": {
"type": "string"
},
"name": {
"type": "object",
"properties": {
"en": {
"type": "string"
},
"fr": {
"type": "string"
},
"de": {
"type": "string"
},
"es": {
"type": "string"
}
},
"required": [
"en",
"fr",
"de",
"es"
]
},
"description": {
"type": "object",
"properties": {
"en": {
"type": "string"
},
"fr": {
"type": "string"
},
"de": {
"type": "string"
},
"es": {
"type": "string"
}
},
"required": [
"en",
"fr",
"de",
"es"
]
},
"alias": {
"type": "string"
},
"position": {
"type": "number"
},
"is_active": {
"type": "boolean"
},
"is_public": {
"type": "boolean"
}
},
"required": [
"pso_type",
"name",
"position",
"is_active",
"is_public"
]
}201Headers
Content-Type: application/jsonBody
{
"data": {
"id": 32,
"alias": "usr_identity",
"position": 5,
"system_required": true,
"name": "Identity",
"description": "...",
"is_active": true,
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"alias": {
"type": "string"
},
"position": {
"type": "number"
},
"system_required": {
"type": "boolean"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"pso_type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"system_required": {
"type": "boolean"
},
"creation_form_instance_id": {
"type": "number"
},
"profile_form_instance_id": {
"type": "number"
}
},
"required": [
"id",
"name",
"alias",
"description",
"is_active",
"system_required",
"creation_form_instance_id",
"profile_form_instance_id"
],
"additionalProperties": false
}
},
"required": [
"id",
"alias",
"position",
"system_required",
"name",
"description",
"is_active"
],
"additionalProperties": false
}
}
}400Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 400
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}401Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 401
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}403Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 403
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}404Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 404
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}406Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 406
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}422Headers
Content-Type: application/jsonBody
{
"message": "Descriptive error message",
"status_code": 422,
"errors": [
"Error message"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
},
"errors": {
"type": "array"
}
}
}500Headers
Content-Type: application/jsonBody
{
"message": "Internal Error",
"status_code": 500
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}ShowGET/category/{alias}
Fetch single fields category item
Example URI
- alias
string(required) Example: somedomainAlias of the Category item.
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>200Headers
Content-Type: application/jsonBody
{
"data": {
"id": 32,
"alias": "usr_identity",
"position": 5,
"system_required": true,
"name": "Identity",
"description": "...",
"is_active": true,
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"alias": {
"type": "string"
},
"position": {
"type": "number"
},
"system_required": {
"type": "boolean"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"pso_type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"system_required": {
"type": "boolean"
},
"creation_form_instance_id": {
"type": "number"
},
"profile_form_instance_id": {
"type": "number"
}
},
"required": [
"id",
"name",
"alias",
"description",
"is_active",
"system_required",
"creation_form_instance_id",
"profile_form_instance_id"
],
"additionalProperties": false
}
},
"required": [
"id",
"alias",
"position",
"system_required",
"name",
"description",
"is_active"
],
"additionalProperties": false
}
}
}401Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 401
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}403Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 403
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}404Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 404
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}406Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 406
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}422Headers
Content-Type: application/jsonBody
{
"message": "Descriptive error message",
"status_code": 422,
"errors": [
"Error message"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
},
"errors": {
"type": "array"
}
}
}500Headers
Content-Type: application/jsonBody
{
"message": "Internal Error",
"status_code": 500
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}DeleteDELETE/category/{alias}
Delete fields category item
Example URI
- alias
string(required) Example: somedomainAlias of the Category item.
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>204Headers
Content-Type: application/json401Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 401
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}403Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 403
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}404Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 404
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}406Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 406
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}422Headers
Content-Type: application/jsonBody
{
"message": "Descriptive error message",
"status_code": 422,
"errors": [
"Error message"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
},
"errors": {
"type": "array"
}
}
}500Headers
Content-Type: application/jsonBody
{
"message": "Internal Error",
"status_code": 500
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}UpdatePATCH/category/{alias}
Update fields category item
Example URI
- alias
string(required) Example: somedomainAlias of the Category item.
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>Body
{
"name": {
"en": "Some text",
"fr": "Du texte",
"de": "Setwas Text",
"es": "Algún texto"
},
"description": {
"en": "Some text",
"fr": "Du texte",
"de": "Setwas Text",
"es": "Algún texto"
},
"position": 5,
"system_required": true,
"is_active": true,
"alias": "usr_global",
"is_public": true
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"name": {
"type": "object",
"properties": {
"en": {
"type": "string"
},
"fr": {
"type": "string"
},
"de": {
"type": "string"
},
"es": {
"type": "string"
}
},
"required": [
"en",
"fr",
"de",
"es"
]
},
"description": {
"type": "object",
"properties": {
"en": {
"type": "string"
},
"fr": {
"type": "string"
},
"de": {
"type": "string"
},
"es": {
"type": "string"
}
},
"required": [
"en",
"fr",
"de",
"es"
]
},
"system_required": {
"type": "boolean"
},
"position": {
"type": "number"
},
"alias": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"is_public": {
"type": "boolean"
}
},
"required": [
"position",
"is_active",
"is_public"
]
}202Headers
Content-Type: application/jsonBody
{
"data": {
"id": 32,
"alias": "usr_identity",
"position": 5,
"system_required": true,
"name": "Identity",
"description": "...",
"is_active": true,
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"alias": {
"type": "string"
},
"position": {
"type": "number"
},
"system_required": {
"type": "boolean"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"pso_type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"system_required": {
"type": "boolean"
},
"creation_form_instance_id": {
"type": "number"
},
"profile_form_instance_id": {
"type": "number"
}
},
"required": [
"id",
"name",
"alias",
"description",
"is_active",
"system_required",
"creation_form_instance_id",
"profile_form_instance_id"
],
"additionalProperties": false
}
},
"required": [
"id",
"alias",
"position",
"system_required",
"name",
"description",
"is_active"
],
"additionalProperties": false
}
}
}400Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 400
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}401Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 401
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}403Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 403
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}404Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 404
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}406Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 406
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}422Headers
Content-Type: application/jsonBody
{
"message": "Descriptive error message",
"status_code": 422,
"errors": [
"Error message"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
},
"errors": {
"type": "array"
}
}
}500Headers
Content-Type: application/jsonBody
{
"message": "Internal Error",
"status_code": 500
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}Chats ¶
Chats section.
Chats ¶
ListGET/chats{?include-empty}
Fetch list of chats
Example URI
- include-empty
boolean(optional) Example: falseInclude new and still empty chats.
By default API returns only not empty chats. To see empty chats you need add that param.
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>200Headers
Content-Type: application/jsonBody
{
"data": [
{
"id": 1,
"author": {
"id": 1,
"external_id": 1,
"first_name": "John",
"last_name": "Snow",
"username": "john_snow",
"professional_email": "jsnow@example.com",
"professional_mobile_phone": "00 33 1 40 00 00 00",
"professional_phone": "00 33 1 40 00 00 00",
"role": [
"bastard",
"king"
],
"is_active": true,
"status": "remote",
"settings": [
"[]"
],
"user_photo": "http://example.com/images/1.jpg"
},
"title": "Chat title",
"is_viewed_by_user": true,
"is_viewed_by_hr": true,
"status": "opened",
"created_at": "2019-04-24 11:47:47",
"updated_at": "2019-04-24 11:47:47"
}
],
"meta": {
"pagination": {
"total": 238,
"count": 25,
"per_page": 25,
"current_page": 2,
"total_pages": 10,
"links": {
"previous": "http://example.com/api/<endpoint>?page=1",
"next": "http://example.com/api/<endpoint>?page=3"
}
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"author": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"external_id": {
"type": "number"
},
"first_name": {
"type": "string"
},
"last_name": {
"type": "string"
},
"username": {
"type": "string"
},
"professional_email": {
"type": "string"
},
"professional_mobile_phone": {
"type": "string"
},
"professional_phone": {
"type": "string"
},
"role": {
"type": "array"
},
"is_active": {
"type": "boolean"
},
"status": {
"type": "string"
},
"settings": {
"type": "array"
},
"user_photo": {
"type": "string"
}
},
"required": [
"id",
"external_id",
"first_name",
"last_name",
"username",
"professional_email",
"professional_mobile_phone",
"professional_phone",
"role",
"is_active",
"status",
"settings",
"user_photo"
],
"additionalProperties": false
},
"title": {
"type": "string"
},
"is_viewed_by_user": {
"type": "boolean"
},
"is_viewed_by_hr": {
"type": "boolean"
},
"status": {
"type": "string",
"enum": [
"opened",
"closed"
]
},
"created_at": {
"type": "string"
},
"updated_at": {
"type": "string"
}
},
"required": [
"id",
"author",
"title",
"is_viewed_by_user",
"is_viewed_by_hr",
"status",
"created_at",
"updated_at"
]
}
},
"meta": {
"type": "object",
"properties": {
"pagination": {
"type": "object",
"properties": {
"total": {
"type": "number"
},
"count": {
"type": "number"
},
"per_page": {
"type": "number"
},
"current_page": {
"type": "number"
},
"total_pages": {
"type": "number"
},
"links": {
"type": "object",
"properties": {
"previous": {
"type": "string"
},
"next": {
"type": "string"
}
},
"required": [
"previous",
"next"
]
}
},
"required": [
"total",
"count",
"per_page",
"current_page",
"total_pages",
"links"
],
"additionalProperties": false
}
},
"required": [
"pagination"
]
}
}
}401Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 401
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}403Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 403
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}404Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 404
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}406Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 406
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}422Headers
Content-Type: application/jsonBody
{
"message": "Descriptive error message",
"status_code": 422,
"errors": [
"Error message"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
},
"errors": {
"type": "array"
}
}
}500Headers
Content-Type: application/jsonBody
{
"message": "Internal Error",
"status_code": 500
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}CreatePOST/chats
Create new chat.
Example URI
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: '*'Body
{
"title": {
"en": "Some text",
"fr": "Du texte",
"de": "Setwas Text",
"es": "Algún texto"
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"title": {
"type": "object",
"properties": {
"en": {
"type": "string"
},
"fr": {
"type": "string"
},
"de": {
"type": "string"
},
"es": {
"type": "string"
}
},
"required": [
"en",
"fr",
"de",
"es"
]
}
},
"required": [
"title"
]
}201Headers
Content-Type: application/jsonBody
{
"data": {
"id": 1,
"author": {
"id": 1,
"external_id": 1,
"first_name": "John",
"last_name": "Snow",
"username": "john_snow",
"professional_email": "jsnow@example.com",
"professional_mobile_phone": "00 33 1 40 00 00 00",
"professional_phone": "00 33 1 40 00 00 00",
"role": [
"bastard",
"king"
],
"is_active": true,
"status": "remote",
"settings": [
"[]"
],
"user_photo": "http://example.com/images/1.jpg"
},
"title": "Chat title",
"is_viewed_by_user": true,
"is_viewed_by_hr": true,
"status": "opened",
"created_at": "2019-04-24 11:47:47",
"updated_at": "2019-04-24 11:47:47"
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"author": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"external_id": {
"type": "number"
},
"first_name": {
"type": "string"
},
"last_name": {
"type": "string"
},
"username": {
"type": "string"
},
"professional_email": {
"type": "string"
},
"professional_mobile_phone": {
"type": "string"
},
"professional_phone": {
"type": "string"
},
"role": {
"type": "array"
},
"is_active": {
"type": "boolean"
},
"status": {
"type": "string"
},
"settings": {
"type": "array"
},
"user_photo": {
"type": "string"
}
},
"required": [
"id",
"external_id",
"first_name",
"last_name",
"username",
"professional_email",
"professional_mobile_phone",
"professional_phone",
"role",
"is_active",
"status",
"settings",
"user_photo"
],
"additionalProperties": false
},
"title": {
"type": "string"
},
"is_viewed_by_user": {
"type": "boolean"
},
"is_viewed_by_hr": {
"type": "boolean"
},
"status": {
"type": "string",
"enum": [
"opened",
"closed"
]
},
"created_at": {
"type": "string"
},
"updated_at": {
"type": "string"
}
},
"required": [
"id",
"author",
"title",
"is_viewed_by_user",
"is_viewed_by_hr",
"status",
"created_at",
"updated_at"
],
"additionalProperties": false
}
}
}400Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 400
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}401Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 401
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}403Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 403
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}404Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 404
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}406Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 406
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}422Headers
Content-Type: application/jsonBody
{
"message": "Descriptive error message",
"status_code": 422,
"errors": [
"Error message"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
},
"errors": {
"type": "array"
}
}
}500Headers
Content-Type: application/jsonBody
{
"message": "Internal Error",
"status_code": 500
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}ShowGET/chats/{id}
Get single chat item and mark it as viewed.
Example URI
- id
number(required) Example: 5Id of the Chat item.
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: '*'200Headers
Content-Type: application/jsonBody
{
"data": {
"id": 1,
"author": {
"id": 1,
"external_id": 1,
"first_name": "John",
"last_name": "Snow",
"username": "john_snow",
"professional_email": "jsnow@example.com",
"professional_mobile_phone": "00 33 1 40 00 00 00",
"professional_phone": "00 33 1 40 00 00 00",
"role": [
"bastard",
"king"
],
"is_active": true,
"status": "remote",
"settings": [
"[]"
],
"user_photo": "http://example.com/images/1.jpg"
},
"title": "Chat title",
"is_viewed_by_user": true,
"is_viewed_by_hr": true,
"status": "opened",
"created_at": "2019-04-24 11:47:47",
"updated_at": "2019-04-24 11:47:47"
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"author": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"external_id": {
"type": "number"
},
"first_name": {
"type": "string"
},
"last_name": {
"type": "string"
},
"username": {
"type": "string"
},
"professional_email": {
"type": "string"
},
"professional_mobile_phone": {
"type": "string"
},
"professional_phone": {
"type": "string"
},
"role": {
"type": "array"
},
"is_active": {
"type": "boolean"
},
"status": {
"type": "string"
},
"settings": {
"type": "array"
},
"user_photo": {
"type": "string"
}
},
"required": [
"id",
"external_id",
"first_name",
"last_name",
"username",
"professional_email",
"professional_mobile_phone",
"professional_phone",
"role",
"is_active",
"status",
"settings",
"user_photo"
],
"additionalProperties": false
},
"title": {
"type": "string"
},
"is_viewed_by_user": {
"type": "boolean"
},
"is_viewed_by_hr": {
"type": "boolean"
},
"status": {
"type": "string",
"enum": [
"opened",
"closed"
]
},
"created_at": {
"type": "string"
},
"updated_at": {
"type": "string"
}
},
"required": [
"id",
"author",
"title",
"is_viewed_by_user",
"is_viewed_by_hr",
"status",
"created_at",
"updated_at"
],
"additionalProperties": false
}
}
}401Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 401
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}403Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 403
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}404Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 404
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}406Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 406
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}422Headers
Content-Type: application/jsonBody
{
"message": "Descriptive error message",
"status_code": 422,
"errors": [
"Error message"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
},
"errors": {
"type": "array"
}
}
}500Headers
Content-Type: application/jsonBody
{
"message": "Internal Error",
"status_code": 500
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}UpdatePATCH/chats/{id}
Update chat status
Example URI
- id
number(required) Example: 123Id of the chat.
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>Body
{
"status": "opened"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"opened",
"closed"
]
}
},
"required": [
"status"
]
}202Headers
Content-Type: application/jsonBody
{
"data": {
"id": 1,
"author": {
"id": 1,
"external_id": 1,
"first_name": "John",
"last_name": "Snow",
"username": "john_snow",
"professional_email": "jsnow@example.com",
"professional_mobile_phone": "00 33 1 40 00 00 00",
"professional_phone": "00 33 1 40 00 00 00",
"role": [
"bastard",
"king"
],
"is_active": true,
"status": "remote",
"settings": [
"[]"
],
"user_photo": "http://example.com/images/1.jpg"
},
"title": "Chat title",
"is_viewed_by_user": true,
"is_viewed_by_hr": true,
"status": "opened",
"created_at": "2019-04-24 11:47:47",
"updated_at": "2019-04-24 11:47:47"
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"author": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"external_id": {
"type": "number"
},
"first_name": {
"type": "string"
},
"last_name": {
"type": "string"
},
"username": {
"type": "string"
},
"professional_email": {
"type": "string"
},
"professional_mobile_phone": {
"type": "string"
},
"professional_phone": {
"type": "string"
},
"role": {
"type": "array"
},
"is_active": {
"type": "boolean"
},
"status": {
"type": "string"
},
"settings": {
"type": "array"
},
"user_photo": {
"type": "string"
}
},
"required": [
"id",
"external_id",
"first_name",
"last_name",
"username",
"professional_email",
"professional_mobile_phone",
"professional_phone",
"role",
"is_active",
"status",
"settings",
"user_photo"
],
"additionalProperties": false
},
"title": {
"type": "string"
},
"is_viewed_by_user": {
"type": "boolean"
},
"is_viewed_by_hr": {
"type": "boolean"
},
"status": {
"type": "string",
"enum": [
"opened",
"closed"
]
},
"created_at": {
"type": "string"
},
"updated_at": {
"type": "string"
}
},
"required": [
"id",
"author",
"title",
"is_viewed_by_user",
"is_viewed_by_hr",
"status",
"created_at",
"updated_at"
],
"additionalProperties": false
}
}
}400Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 400
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}401Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 401
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}403Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 403
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}404Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 404
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}406Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 406
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}422Headers
Content-Type: application/jsonBody
{
"message": "Descriptive error message",
"status_code": 422,
"errors": [
"Error message"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
},
"errors": {
"type": "array"
}
}
}500Headers
Content-Type: application/jsonBody
{
"message": "Internal Error",
"status_code": 500
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}Messages ¶
ListGET/chats/{id}/messages
Fetch list of chat messages(with attachments, if added). Visiting that url also marks chat as viewed.
Example URI
- id
number(required) Example: 5Chat id
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>200Headers
Content-Type: application/jsonBody
{
"data": [
{
"id": 1,
"author": {
"id": 1,
"external_id": 1,
"first_name": "John",
"last_name": "Snow",
"username": "john_snow",
"professional_email": "jsnow@example.com",
"professional_mobile_phone": "00 33 1 40 00 00 00",
"professional_phone": "00 33 1 40 00 00 00",
"role": [
"bastard",
"king"
],
"is_active": true,
"status": "remote",
"settings": [
"[]"
],
"user_photo": "http://example.com/images/1.jpg"
},
"chat_id": 1,
"message": "Message text",
"attachments": [
{
"id": 1,
"url": "http://example.com/images/logo.jpg",
"original_name": "logo",
"format": "jpg"
}
],
"created_at": "2019-04-24 11:47:47"
}
],
"meta": {
"pagination": {
"total": 238,
"count": 25,
"per_page": 25,
"current_page": 2,
"total_pages": 10,
"links": {
"previous": "http://example.com/api/<endpoint>?page=1",
"next": "http://example.com/api/<endpoint>?page=3"
}
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"author": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"external_id": {
"type": "number"
},
"first_name": {
"type": "string"
},
"last_name": {
"type": "string"
},
"username": {
"type": "string"
},
"professional_email": {
"type": "string"
},
"professional_mobile_phone": {
"type": "string"
},
"professional_phone": {
"type": "string"
},
"role": {
"type": "array"
},
"is_active": {
"type": "boolean"
},
"status": {
"type": "string"
},
"settings": {
"type": "array"
},
"user_photo": {
"type": "string"
}
},
"required": [
"id",
"external_id",
"first_name",
"last_name",
"username",
"professional_email",
"professional_mobile_phone",
"professional_phone",
"role",
"is_active",
"status",
"settings",
"user_photo"
],
"additionalProperties": false
},
"chat_id": {
"type": "number"
},
"message": {
"type": "string"
},
"attachments": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"url": {
"type": "string"
},
"original_name": {
"type": "string"
},
"format": {
"type": "string"
}
},
"required": [
"id",
"url",
"original_name",
"format"
]
}
},
"created_at": {
"type": "string"
}
},
"required": [
"id",
"author",
"chat_id",
"message",
"created_at"
]
}
},
"meta": {
"type": "object",
"properties": {
"pagination": {
"type": "object",
"properties": {
"total": {
"type": "number"
},
"count": {
"type": "number"
},
"per_page": {
"type": "number"
},
"current_page": {
"type": "number"
},
"total_pages": {
"type": "number"
},
"links": {
"type": "object",
"properties": {
"previous": {
"type": "string"
},
"next": {
"type": "string"
}
},
"required": [
"previous",
"next"
]
}
},
"required": [
"total",
"count",
"per_page",
"current_page",
"total_pages",
"links"
],
"additionalProperties": false
}
},
"required": [
"pagination"
]
}
}
}401Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 401
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}403Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 403
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}404Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 404
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}406Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 406
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}422Headers
Content-Type: application/jsonBody
{
"message": "Descriptive error message",
"status_code": 422,
"errors": [
"Error message"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
},
"errors": {
"type": "array"
}
}
}500Headers
Content-Type: application/jsonBody
{
"message": "Internal Error",
"status_code": 500
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}CreatePOST/chats/{id}/messages
Create a new message into the chat.
Example URI
- id
number(required) Example: 5Target chat id
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: '*'Body
{
"message": "Message body",
"attachments": [
{
"url": "http://example.com/images/logo.jpg",
"original_name": "logo",
"format": "jpg"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": [
"string",
"null"
],
"description": "max length 255 chars."
},
"attachments": {
"type": "array"
}
},
"required": [
"message"
]
}201Headers
Content-Type: application/jsonBody
{
"data": {
"id": 1,
"author": {
"id": 1,
"external_id": 1,
"first_name": "John",
"last_name": "Snow",
"username": "john_snow",
"professional_email": "jsnow@example.com",
"professional_mobile_phone": "00 33 1 40 00 00 00",
"professional_phone": "00 33 1 40 00 00 00",
"role": [
"bastard",
"king"
],
"is_active": true,
"status": "remote",
"settings": [
"[]"
],
"user_photo": "http://example.com/images/1.jpg"
},
"chat_id": 1,
"message": "Message text",
"attachments": [
{
"id": 1,
"url": "http://example.com/images/logo.jpg",
"original_name": "logo",
"format": "jpg"
}
],
"created_at": "2019-04-24 11:47:47"
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"author": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"external_id": {
"type": "number"
},
"first_name": {
"type": "string"
},
"last_name": {
"type": "string"
},
"username": {
"type": "string"
},
"professional_email": {
"type": "string"
},
"professional_mobile_phone": {
"type": "string"
},
"professional_phone": {
"type": "string"
},
"role": {
"type": "array"
},
"is_active": {
"type": "boolean"
},
"status": {
"type": "string"
},
"settings": {
"type": "array"
},
"user_photo": {
"type": "string"
}
},
"required": [
"id",
"external_id",
"first_name",
"last_name",
"username",
"professional_email",
"professional_mobile_phone",
"professional_phone",
"role",
"is_active",
"status",
"settings",
"user_photo"
],
"additionalProperties": false
},
"chat_id": {
"type": "number"
},
"message": {
"type": "string"
},
"attachments": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"url": {
"type": "string"
},
"original_name": {
"type": "string"
},
"format": {
"type": "string"
}
},
"required": [
"id",
"url",
"original_name",
"format"
]
}
},
"created_at": {
"type": "string"
}
},
"required": [
"id",
"author",
"chat_id",
"message",
"created_at"
],
"additionalProperties": false
}
}
}400Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 400
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}401Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 401
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}403Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 403
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}404Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 404
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}406Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 406
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}422Headers
Content-Type: application/jsonBody
{
"message": "Descriptive error message",
"status_code": 422,
"errors": [
"Error message"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
},
"errors": {
"type": "array"
}
}
}500Headers
Content-Type: application/jsonBody
{
"message": "Internal Error",
"status_code": 500
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}Company ¶
Show info ¶
Show infoGET/companies/info
Fetch company info
Example URI
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <comma separated features>200Headers
Content-Type: application/jsonBody
{
"data": {
"name": "First Company",
"external_id": "absdfdfdf-bsdsvsdfgbf-fdsdfsd",
"phone": "89348612390",
"employees_count": 10,
"settings": [
{
"alias": "default_language",
"value": "en"
},
{
"alias": "background_color",
"value": "#5f5c28"
},
{
"alias": "icon_color",
"value": "#5f5c28"
},
{
"alias": "title_color",
"value": "#5f5c28"
},
{
"alias": "second_title_color",
"value": "#5f5c28"
},
{
"alias": "button_color",
"value": "#5f5c28"
},
{
"alias": "web_logo",
"value": "https://rest-dev.monportailrh.com/storage/company/logo.png"
},
{
"alias": "logout_url",
"value": "https://example.com"
},
{
"alias": "idp_name",
"value": "value of idp_name"
},
{
"alias": "idp_type",
"value": "value of idp_type"
},
{
"alias": "identifier_type",
"value": "value of identifier_type"
}
]
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"external_id": {
"type": "string"
},
"phone": {
"type": "string"
},
"employees_count": {
"type": "number"
},
"settings": {
"type": "array"
}
},
"required": [
"name",
"external_id",
"phone",
"employees_count",
"settings"
],
"additionalProperties": false
}
}
}401Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 401
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}403Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 403
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}404Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 404
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}406Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 406
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}422Headers
Content-Type: application/jsonBody
{
"message": "Descriptive error message",
"status_code": 422,
"errors": [
"Error message"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
},
"errors": {
"type": "array"
}
}
}500Headers
Content-Type: application/jsonBody
{
"message": "Internal Error",
"status_code": 500
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}Show settings ¶
Show settingsGET/companies/settings?
Fetch company settings
Example URI
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <comma separated features>200Headers
Content-Type: application/jsonBody
{
"data": [
{
"alias": "default_language",
"value": "en"
},
{
"alias": "background_color",
"value": "#5f5c28"
},
{
"alias": "icon_color",
"value": "#5f5c28"
},
{
"alias": "title_color",
"value": "#5f5c28"
},
{
"alias": "second_title_color",
"value": "#5f5c28"
},
{
"alias": "button_color",
"value": "#5f5c28"
},
{
"alias": "web_logo",
"value": "https://rest-dev.monportailrh.com/storage/company/logo.png"
},
{
"alias": "logout_url",
"value": "https://example.com"
},
{
"alias": "idp_name",
"value": "value of idp_name"
},
{
"alias": "idp_type",
"value": "value of idp_type"
},
{
"alias": "identifier_type",
"value": "value of identifier_type"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"alias": {
"type": "string",
"enum": [
"default_language"
]
},
"value": {
"type": [
"string",
"null"
],
"enum": [
"en",
null
]
}
},
"required": [
"alias"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"alias": {
"type": "string",
"enum": [
"background_color"
]
},
"value": {
"type": [
"string",
"null"
],
"enum": [
"#5f5c28",
null
]
}
},
"required": [
"alias"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"alias": {
"type": "string",
"enum": [
"icon_color"
]
},
"value": {
"type": [
"string",
"null"
],
"enum": [
"#5f5c28",
null
]
}
},
"required": [
"alias"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"alias": {
"type": "string",
"enum": [
"title_color"
]
},
"value": {
"type": [
"string",
"null"
],
"enum": [
"#5f5c28",
null
]
}
},
"required": [
"alias"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"alias": {
"type": "string",
"enum": [
"second_title_color"
]
},
"value": {
"type": [
"string",
"null"
],
"enum": [
"#5f5c28",
null
]
}
},
"required": [
"alias"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"alias": {
"type": "string",
"enum": [
"button_color"
]
},
"value": {
"type": [
"string",
"null"
],
"enum": [
"#5f5c28",
null
]
}
},
"required": [
"alias"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"alias": {
"type": "string",
"enum": [
"web_logo"
]
},
"value": {
"type": [
"string",
"null"
],
"enum": [
"https://rest-dev.monportailrh.com/storage/company/logo.png",
null
]
}
},
"required": [
"alias"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"alias": {
"type": "string",
"enum": [
"logout_url"
]
},
"value": {
"type": [
"string",
"null"
],
"enum": [
"https://example.com",
null
]
}
},
"required": [
"alias"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"alias": {
"type": "string",
"enum": [
"idp_name"
]
},
"value": {
"type": [
"string",
"null"
],
"enum": [
"value of idp_name",
null
]
}
},
"required": [
"alias",
"value"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"alias": {
"type": "string",
"enum": [
"idp_type"
]
},
"value": {
"type": [
"string",
"null"
],
"enum": [
"value of idp_type",
null
]
}
},
"required": [
"alias",
"value"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"alias": {
"type": "string",
"enum": [
"identifier_type"
]
},
"value": {
"type": [
"string",
"null"
],
"enum": [
"value of identifier_type",
null
]
}
},
"required": [
"alias",
"value"
],
"additionalProperties": false
}
]
}
},
"required": [
"data"
]
}401Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 401
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}403Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 403
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}404Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 404
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}406Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 406
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}422Headers
Content-Type: application/jsonBody
{
"message": "Descriptive error message",
"status_code": 422,
"errors": [
"Error message"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
},
"errors": {
"type": "array"
}
}
}500Headers
Content-Type: application/jsonBody
{
"message": "Internal Error",
"status_code": 500
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}Update settings ¶
Update settingsPATCH/companies/settings
Update company settings
Example URI
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>Body
{
"default_language": "en",
"background_color": "#5f5c28",
"header_color": "#5f5c28",
"icon_color": "#5f5c28",
"title_color": "#5f5c28",
"second_title_color": "#5f5c28",
"button_color": "#5f5c28",
"web_logo": "https://rest-dev.monportailrh.com/storage/company/logo.png",
"logout_url": "https://example.com",
"idp_name": "value",
"idp_type": "value",
"identifier_type": "#5f5c28"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"default_language": {
"type": [
"string",
"null"
]
},
"background_color": {
"type": [
"string",
"null"
]
},
"header_color": {
"type": [
"string",
"null"
]
},
"icon_color": {
"type": [
"string",
"null"
]
},
"title_color": {
"type": [
"string",
"null"
]
},
"second_title_color": {
"type": [
"string",
"null"
]
},
"button_color": {
"type": [
"string",
"null"
]
},
"web_logo": {
"type": [
"string",
"null"
]
},
"logout_url": {
"type": [
"string",
"null"
]
},
"idp_name": {
"type": [
"string",
"null"
]
},
"idp_type": {
"type": [
"string",
"null"
]
},
"identifier_type": {
"type": "string"
}
}
}202Headers
Content-Type: application/json400Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 400
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}401Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 401
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}403Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 403
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}404Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 404
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}406Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 406
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}422Headers
Content-Type: application/jsonBody
{
"message": "Descriptive error message",
"status_code": 422,
"errors": [
"Error message"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
},
"errors": {
"type": "array"
}
}
}500Headers
Content-Type: application/jsonBody
{
"message": "Internal Error",
"status_code": 500
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}Connector Builder ¶
Connector builder consists from few parts.
Export
Export is a way to extract desired data from system to the file (CSV or XLS)
Management Permissions:
connector_builder_export.manage.*- Allows to create, edit and remove export mappings for all Pso Types
Pso Type specific permissions:
connector_builder_export.manage.<trigram>- Allows to create, edit and remove export mappings for specific Pso Type only
Common flow
Once the export map created - it may be used to do an export.
Preparing and formatting data may take some time, so it will be done in asynchronous way.
To initiate the process we need to run export (see related section). status for affected export map will be changed to processing
Once the process completed status for affected export map will be changed to done or failed (it depends whether result successful or not)
More details about export process can be got by using Export Logs endpoint
Import
Import is a way to load desired data into system from file (XLS)
Pso Type specific permissions:
-
connector_builder_imports.view.<trigram> -
connector_builder_imports.create.<trigram> -
connector_builder_imports.edit.<trigram> -
connector_builder_imports.delete.<trigram>
Exports ¶
ListGET/connector-builder/exports{?name,pso-type,active,sort,order,include}
Fetch list of export maps
Example URI
- name
string(optional) Example: Export map to search forSearch by name. Non strict, case-insensitive.
- pso-type
string(required) Example: usrPso Type trigram to filter export maps for
- active
boolean(optional) Example: trueField for filter exports by
is_activecolumn- sort
pso-type, name(optional) Default: name Example: titleField to sort export maps by.
- order
asc, desc(optional) Default: asc Example: ascDirection to order export maps by.
- include
pso_type, mapping, mapping.root_field, language, owner(optional) Example: pso_type,languageThe way to include relations in the response. Target relations can be comma separated if you want to get few of them
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>200Headers
Content-Type: application/jsonBody
{
"data": [
{
"id": 132,
"alias": "my_widget",
"name": "Export mapping Name",
"description": "Some description",
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
},
"is_active": true,
"is_locked": false,
"status": "new",
"report_file": "filename.csv",
"mapping": [
{
"internal": 123,
"external": "Active",
"root_field": {
"id": 1,
"name": "Field Name",
"position": 5,
"alias": "usr_first_name",
"has_unique_data": false,
"has_value": true,
"removable": false,
"is_active": true,
"list": false,
"read_only": false,
"required": true,
"type": {
"id": 1,
"name": "Data Type Name",
"alias": "data_type_alias",
"settings": [
{
"id": 1,
"name": "Data Type Setting Name",
"alias": "data_type_setting_alias",
"is_required": true
}
],
"supports_collection": false,
"supports_read_only": false,
"supports_unique": false
},
"category": {
"id": 32,
"alias": "usr_identity",
"position": 5,
"system_required": true,
"name": "Identity",
"description": "...",
"is_active": true,
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
}
},
"domains": [
{
"id": 46,
"alias": "usr_global",
"name": "User Global",
"description": "...",
"is_editable": false,
"is_removable": false,
"is_active": true,
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
}
}
],
"privacy_level": {
"id": 123,
"alias": "public",
"name": "Not Sensitive",
"level": 100
},
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
},
"items": [
{}
],
"options": [
{
"id": 198,
"name": "Chose me!",
"position": 9,
"value": "198",
"is_active": true
}
],
"settings": []
}
}
],
"language": {
"id": 1,
"alias": "en",
"name": "English"
},
"owner": {
"id": 1,
"external_id": 1,
"first_name": "John",
"last_name": "Snow",
"username": "john_snow",
"professional_email": "jsnow@example.com",
"professional_mobile_phone": "00 33 1 40 00 00 00",
"professional_phone": "00 33 1 40 00 00 00",
"role": [
"bastard",
"king"
],
"is_active": true,
"status": "remote",
"settings": [
"[]"
],
"user_photo": "http://example.com/images/1.jpg"
},
"conditions": [
{
"type": "group",
"combine_with": "and",
"conditions": [
{
"type": "condition",
"field": "usr_email",
"raw_value": "john.doe@example.com",
"operator": "=="
}
]
}
],
"permissions": {
"can_edit": true,
"can_delete": false,
"can_deactivate": true
},
"created_at": "2019-01-01 23:34:40",
"updated_at": "2019-01-01 23:34:40"
}
],
"meta": {
"pagination": {
"total": 238,
"count": 25,
"per_page": 25,
"current_page": 2,
"total_pages": 10,
"links": {
"previous": "http://example.com/api/<endpoint>?page=1",
"next": "http://example.com/api/<endpoint>?page=3"
}
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"alias": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"pso_type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"system_required": {
"type": "boolean"
},
"creation_form_instance_id": {
"type": "number"
},
"profile_form_instance_id": {
"type": "number"
}
},
"required": [
"id",
"name",
"alias",
"description",
"is_active",
"system_required",
"creation_form_instance_id",
"profile_form_instance_id"
],
"additionalProperties": false
},
"is_active": {
"type": "boolean"
},
"is_locked": {
"type": "boolean"
},
"status": {
"type": "string",
"enum": [
"new",
"processing",
"done",
"failed"
]
},
"report_file": {
"type": "string"
},
"mapping": {
"type": "array",
"items": {
"type": "object",
"properties": {
"internal": {
"type": "number"
},
"external": {
"type": "string"
},
"root_field": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"position": {
"type": "number"
},
"alias": {
"type": "string"
},
"has_unique_data": {
"type": "boolean",
"description": "whether field requires values to be unique across system"
},
"has_value": {
"type": "boolean",
"description": "whether field has at least one value submitted"
},
"removable": {
"type": "boolean",
"description": "whether field can be removed from system"
},
"is_active": {
"type": "boolean"
},
"list": {
"type": "boolean",
"description": "whether field can handle collection of values"
},
"read_only": {
"type": "boolean",
"description": "whether field value can be changed"
},
"required": {
"type": "boolean",
"description": "whether field value required by system"
},
"type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"settings": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"is_required": {
"type": "boolean"
}
},
"required": [
"id",
"name",
"alias",
"is_required"
]
}
},
"supports_collection": {
"type": "boolean"
},
"supports_read_only": {
"type": "boolean"
},
"supports_unique": {
"type": "boolean"
}
},
"required": [
"id",
"name",
"alias",
"settings",
"supports_collection",
"supports_read_only",
"supports_unique"
],
"additionalProperties": false
},
"category": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"alias": {
"type": "string"
},
"position": {
"type": "number"
},
"system_required": {
"type": "boolean"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"pso_type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"system_required": {
"type": "boolean"
},
"creation_form_instance_id": {
"type": "number"
},
"profile_form_instance_id": {
"type": "number"
}
},
"required": [
"id",
"name",
"alias",
"description",
"is_active",
"system_required",
"creation_form_instance_id",
"profile_form_instance_id"
],
"additionalProperties": false
}
},
"required": [
"id",
"alias",
"position",
"system_required",
"name",
"description",
"is_active"
],
"additionalProperties": false
},
"domains": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"alias": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"is_editable": {
"type": "boolean"
},
"is_removable": {
"type": "boolean"
},
"is_active": {
"type": "boolean"
},
"pso_type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"system_required": {
"type": "boolean"
},
"creation_form_instance_id": {
"type": "number"
},
"profile_form_instance_id": {
"type": "number"
}
},
"required": [
"id",
"name",
"alias",
"description",
"is_active",
"system_required",
"creation_form_instance_id",
"profile_form_instance_id"
],
"additionalProperties": false
}
},
"required": [
"id",
"alias",
"name",
"description",
"is_editable",
"is_removable",
"is_active"
]
}
},
"privacy_level": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"alias": {
"type": "string"
},
"name": {
"type": "string"
},
"level": {
"type": "number"
}
},
"required": [
"id",
"alias",
"name",
"level"
],
"additionalProperties": false
},
"pso_type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"system_required": {
"type": "boolean"
},
"creation_form_instance_id": {
"type": "number"
},
"profile_form_instance_id": {
"type": "number"
}
},
"required": [
"id",
"name",
"alias",
"description",
"is_active",
"system_required",
"creation_form_instance_id",
"profile_form_instance_id"
],
"additionalProperties": false
},
"items": {
"type": [
"array",
"null"
],
"items": {
"type": "object",
"properties": {}
}
},
"options": {
"type": [
"array",
"null"
],
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"position": {
"type": "number"
},
"value": {
"type": "string"
},
"is_active": {
"type": "boolean"
}
},
"required": [
"id",
"name",
"position",
"value",
"is_active"
]
},
"description": "List of options with possible (allowed) values."
},
"settings": {
"type": "array",
"items": {
"type": "string"
},
"description": "Common field settings"
}
},
"required": [
"id",
"name",
"position",
"alias",
"has_unique_data",
"has_value",
"removable",
"is_active",
"list",
"read_only",
"required",
"items",
"options"
],
"additionalProperties": false
}
},
"required": [
"internal",
"external"
]
}
},
"language": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"alias": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"id",
"alias",
"name"
]
},
"owner": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"external_id": {
"type": "number"
},
"first_name": {
"type": "string"
},
"last_name": {
"type": "string"
},
"username": {
"type": "string"
},
"professional_email": {
"type": "string"
},
"professional_mobile_phone": {
"type": "string"
},
"professional_phone": {
"type": "string"
},
"role": {
"type": "array"
},
"is_active": {
"type": "boolean"
},
"status": {
"type": "string"
},
"settings": {
"type": "array"
},
"user_photo": {
"type": "string"
}
},
"required": [
"id",
"external_id",
"first_name",
"last_name",
"username",
"professional_email",
"professional_mobile_phone",
"professional_phone",
"role",
"is_active",
"status",
"settings",
"user_photo"
],
"additionalProperties": false
},
"conditions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"group"
]
},
"combine_with": {
"type": "string",
"enum": [
"and",
"or"
]
},
"conditions": {
"type": "array"
}
},
"required": [
"type",
"combine_with",
"conditions"
]
}
},
"permissions": {
"type": "object",
"properties": {
"can_edit": {
"type": "boolean"
},
"can_delete": {
"type": "boolean"
},
"can_deactivate": {
"type": "boolean"
}
},
"required": [
"can_edit",
"can_delete",
"can_deactivate"
]
},
"created_at": {
"type": "string"
},
"updated_at": {
"type": "string"
}
},
"required": [
"alias",
"name",
"description",
"is_active",
"status",
"mapping",
"language",
"created_at",
"updated_at"
]
}
},
"meta": {
"type": "object",
"properties": {
"pagination": {
"type": "object",
"properties": {
"total": {
"type": "number"
},
"count": {
"type": "number"
},
"per_page": {
"type": "number"
},
"current_page": {
"type": "number"
},
"total_pages": {
"type": "number"
},
"links": {
"type": "object",
"properties": {
"previous": {
"type": "string"
},
"next": {
"type": "string"
}
},
"required": [
"previous",
"next"
]
}
},
"required": [
"total",
"count",
"per_page",
"current_page",
"total_pages",
"links"
],
"additionalProperties": false
}
},
"required": [
"pagination"
]
}
}
}401Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 401
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}403Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 403
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}404Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 404
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}406Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 406
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}422Headers
Content-Type: application/jsonBody
{
"message": "Descriptive error message",
"status_code": 422,
"errors": [
"Error message"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
},
"errors": {
"type": "array"
}
}
}500Headers
Content-Type: application/jsonBody
{
"message": "Internal Error",
"status_code": 500
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}ShowGET/connector-builder/exports/{alias}{?include}
Fetch specified export map
Example URI
- alias
string(required) Example: usr_reportAlias of the Export Mapping.
- include
pso_type, mapping, mapping.root_field, language, owner(optional) Example: pso_type,languageThe way to include relations in the response. Target relations can be comma separated if you want to get few of them
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <comma separated features>200Headers
Content-Type: application/jsonBody
{
"data": {
"id": 132,
"alias": "my_widget",
"name": "Export mapping Name",
"description": "Some description",
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
},
"is_active": true,
"is_locked": false,
"status": "new",
"report_file": "filename.csv",
"mapping": [
{
"internal": 123,
"external": "Active",
"root_field": {
"id": 1,
"name": "Field Name",
"position": 5,
"alias": "usr_first_name",
"has_unique_data": false,
"has_value": true,
"removable": false,
"is_active": true,
"list": false,
"read_only": false,
"required": true,
"type": {
"id": 1,
"name": "Data Type Name",
"alias": "data_type_alias",
"settings": [
{
"id": 1,
"name": "Data Type Setting Name",
"alias": "data_type_setting_alias",
"is_required": true
}
],
"supports_collection": false,
"supports_read_only": false,
"supports_unique": false
},
"category": {
"id": 32,
"alias": "usr_identity",
"position": 5,
"system_required": true,
"name": "Identity",
"description": "...",
"is_active": true,
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
}
},
"domains": [
{
"id": 46,
"alias": "usr_global",
"name": "User Global",
"description": "...",
"is_editable": false,
"is_removable": false,
"is_active": true,
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
}
}
],
"privacy_level": {
"id": 123,
"alias": "public",
"name": "Not Sensitive",
"level": 100
},
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
},
"items": [
{}
],
"options": [
{
"id": 198,
"name": "Chose me!",
"position": 9,
"value": "198",
"is_active": true
}
],
"settings": []
}
}
],
"language": {
"id": 1,
"alias": "en",
"name": "English"
},
"owner": {
"id": 1,
"external_id": 1,
"first_name": "John",
"last_name": "Snow",
"username": "john_snow",
"professional_email": "jsnow@example.com",
"professional_mobile_phone": "00 33 1 40 00 00 00",
"professional_phone": "00 33 1 40 00 00 00",
"role": [
"bastard",
"king"
],
"is_active": true,
"status": "remote",
"settings": [
"[]"
],
"user_photo": "http://example.com/images/1.jpg"
},
"conditions": [
{
"type": "group",
"combine_with": "and",
"conditions": [
{
"type": "condition",
"field": "usr_email",
"raw_value": "john.doe@example.com",
"operator": "=="
}
]
}
],
"permissions": {
"can_edit": true,
"can_delete": false,
"can_deactivate": true
},
"created_at": "2019-01-01 23:34:40",
"updated_at": "2019-01-01 23:34:40"
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"alias": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"pso_type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"system_required": {
"type": "boolean"
},
"creation_form_instance_id": {
"type": "number"
},
"profile_form_instance_id": {
"type": "number"
}
},
"required": [
"id",
"name",
"alias",
"description",
"is_active",
"system_required",
"creation_form_instance_id",
"profile_form_instance_id"
],
"additionalProperties": false
},
"is_active": {
"type": "boolean"
},
"is_locked": {
"type": "boolean"
},
"status": {
"type": "string",
"enum": [
"new",
"processing",
"done",
"failed"
]
},
"report_file": {
"type": "string"
},
"mapping": {
"type": "array",
"items": {
"type": "object",
"properties": {
"internal": {
"type": "number"
},
"external": {
"type": "string"
},
"root_field": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"position": {
"type": "number"
},
"alias": {
"type": "string"
},
"has_unique_data": {
"type": "boolean",
"description": "whether field requires values to be unique across system"
},
"has_value": {
"type": "boolean",
"description": "whether field has at least one value submitted"
},
"removable": {
"type": "boolean",
"description": "whether field can be removed from system"
},
"is_active": {
"type": "boolean"
},
"list": {
"type": "boolean",
"description": "whether field can handle collection of values"
},
"read_only": {
"type": "boolean",
"description": "whether field value can be changed"
},
"required": {
"type": "boolean",
"description": "whether field value required by system"
},
"type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"settings": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"is_required": {
"type": "boolean"
}
},
"required": [
"id",
"name",
"alias",
"is_required"
]
}
},
"supports_collection": {
"type": "boolean"
},
"supports_read_only": {
"type": "boolean"
},
"supports_unique": {
"type": "boolean"
}
},
"required": [
"id",
"name",
"alias",
"settings",
"supports_collection",
"supports_read_only",
"supports_unique"
],
"additionalProperties": false
},
"category": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"alias": {
"type": "string"
},
"position": {
"type": "number"
},
"system_required": {
"type": "boolean"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"pso_type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"system_required": {
"type": "boolean"
},
"creation_form_instance_id": {
"type": "number"
},
"profile_form_instance_id": {
"type": "number"
}
},
"required": [
"id",
"name",
"alias",
"description",
"is_active",
"system_required",
"creation_form_instance_id",
"profile_form_instance_id"
],
"additionalProperties": false
}
},
"required": [
"id",
"alias",
"position",
"system_required",
"name",
"description",
"is_active"
],
"additionalProperties": false
},
"domains": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"alias": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"is_editable": {
"type": "boolean"
},
"is_removable": {
"type": "boolean"
},
"is_active": {
"type": "boolean"
},
"pso_type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"system_required": {
"type": "boolean"
},
"creation_form_instance_id": {
"type": "number"
},
"profile_form_instance_id": {
"type": "number"
}
},
"required": [
"id",
"name",
"alias",
"description",
"is_active",
"system_required",
"creation_form_instance_id",
"profile_form_instance_id"
],
"additionalProperties": false
}
},
"required": [
"id",
"alias",
"name",
"description",
"is_editable",
"is_removable",
"is_active"
]
}
},
"privacy_level": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"alias": {
"type": "string"
},
"name": {
"type": "string"
},
"level": {
"type": "number"
}
},
"required": [
"id",
"alias",
"name",
"level"
],
"additionalProperties": false
},
"pso_type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"system_required": {
"type": "boolean"
},
"creation_form_instance_id": {
"type": "number"
},
"profile_form_instance_id": {
"type": "number"
}
},
"required": [
"id",
"name",
"alias",
"description",
"is_active",
"system_required",
"creation_form_instance_id",
"profile_form_instance_id"
],
"additionalProperties": false
},
"items": {
"type": [
"array",
"null"
],
"items": {
"type": "object",
"properties": {}
}
},
"options": {
"type": [
"array",
"null"
],
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"position": {
"type": "number"
},
"value": {
"type": "string"
},
"is_active": {
"type": "boolean"
}
},
"required": [
"id",
"name",
"position",
"value",
"is_active"
]
},
"description": "List of options with possible (allowed) values."
},
"settings": {
"type": "array",
"items": {
"type": "string"
},
"description": "Common field settings"
}
},
"required": [
"id",
"name",
"position",
"alias",
"has_unique_data",
"has_value",
"removable",
"is_active",
"list",
"read_only",
"required",
"items",
"options"
],
"additionalProperties": false
}
},
"required": [
"internal",
"external"
]
}
},
"language": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"alias": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"id",
"alias",
"name"
]
},
"owner": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"external_id": {
"type": "number"
},
"first_name": {
"type": "string"
},
"last_name": {
"type": "string"
},
"username": {
"type": "string"
},
"professional_email": {
"type": "string"
},
"professional_mobile_phone": {
"type": "string"
},
"professional_phone": {
"type": "string"
},
"role": {
"type": "array"
},
"is_active": {
"type": "boolean"
},
"status": {
"type": "string"
},
"settings": {
"type": "array"
},
"user_photo": {
"type": "string"
}
},
"required": [
"id",
"external_id",
"first_name",
"last_name",
"username",
"professional_email",
"professional_mobile_phone",
"professional_phone",
"role",
"is_active",
"status",
"settings",
"user_photo"
],
"additionalProperties": false
},
"conditions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"group"
]
},
"combine_with": {
"type": "string",
"enum": [
"and",
"or"
]
},
"conditions": {
"type": "array"
}
},
"required": [
"type",
"combine_with",
"conditions"
]
}
},
"permissions": {
"type": "object",
"properties": {
"can_edit": {
"type": "boolean"
},
"can_delete": {
"type": "boolean"
},
"can_deactivate": {
"type": "boolean"
}
},
"required": [
"can_edit",
"can_delete",
"can_deactivate"
]
},
"created_at": {
"type": "string"
},
"updated_at": {
"type": "string"
}
},
"required": [
"id",
"alias",
"name",
"description",
"is_active",
"is_locked",
"status",
"report_file",
"mapping",
"language",
"conditions",
"permissions",
"created_at",
"updated_at"
],
"additionalProperties": false
}
}
}401Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 401
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}403Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 403
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}404Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 404
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}406Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 406
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}422Headers
Content-Type: application/jsonBody
{
"message": "Descriptive error message",
"status_code": 422,
"errors": [
"Error message"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
},
"errors": {
"type": "array"
}
}
}500Headers
Content-Type: application/jsonBody
{
"message": "Internal Error",
"status_code": 500
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}Trigger data exportPOST/connector-builder/exports/{alias}/run
Start data export process using specified mapping
Example URI
- alias
string(required) Example: usr_reportId of the Export Mapping.
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <comma separated features>Body
{
"output_format": "csv"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"output_format": {
"type": "string",
"enum": [
"csv",
"xls"
]
}
},
"required": [
"output_format"
]
}202Headers
Content-Type: application/json400Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 400
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}401Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 401
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}403Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 403
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}404Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 404
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}406Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 406
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}422Headers
Content-Type: application/jsonBody
{
"message": "Descriptive error message",
"status_code": 422,
"errors": [
"Error message"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
},
"errors": {
"type": "array"
}
}
}500Headers
Content-Type: application/jsonBody
{
"message": "Internal Error",
"status_code": 500
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}Download Exported dataGET/connector-builder/exports/{alias}/download/{filename}
Download latest export result for specified mapping
Example URI
- alias
string(required) Example: usr_reportAlias of the Export Mapping.
- filename
string(required) Example: user_report27_12_2019_15_20_35.csv Report filename for download
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <comma separated features>200Headers
Content-Type: text/csv200Headers
Content-Type: application/vnd.ms-excel200Headers
Content-Type: application/pdf400Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 400
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}401Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 401
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}403Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 403
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}404Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 404
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}406Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 406
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}422Headers
Content-Type: application/jsonBody
{
"message": "Descriptive error message",
"status_code": 422,
"errors": [
"Error message"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
},
"errors": {
"type": "array"
}
}
}500Headers
Content-Type: application/jsonBody
{
"message": "Internal Error",
"status_code": 500
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}Get Export LogsGET/connector-builder/exports/{alias}/logs
Fetch export process logs for specified mapping
Example URI
- alias
string(required) Example: usr_reportId of the Export Mapping.
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <comma separated features>200Headers
Content-Type: application/jsonBody
{
"data": [
{
"id": 123,
"started_at": "2019-01-01 23:34:40",
"finished_at": "2019-01-01 23:34:40",
"result": "ok",
"log_file": "logs/numeric_scale",
"report_file": "numeric_scale",
"user": {
"id": 1,
"external_id": 1,
"first_name": "John",
"last_name": "Snow",
"username": "john_snow",
"professional_email": "jsnow@example.com",
"professional_mobile_phone": "00 33 1 40 00 00 00",
"professional_phone": "00 33 1 40 00 00 00",
"role": [
"bastard",
"king"
],
"is_active": true,
"status": "remote",
"settings": [
"[]"
],
"user_photo": "http://example.com/images/1.jpg"
}
}
],
"meta": {
"pagination": {
"total": 238,
"count": 25,
"per_page": 25,
"current_page": 2,
"total_pages": 10,
"links": {
"previous": "http://example.com/api/<endpoint>?page=1",
"next": "http://example.com/api/<endpoint>?page=3"
}
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"started_at": {
"type": "string"
},
"finished_at": {
"type": "string"
},
"result": {
"type": "string",
"enum": [
"ok",
"failed"
]
},
"log_file": {
"type": "string",
"description": "181220190931.log (string, required)"
},
"report_file": {
"type": "string",
"description": "181220190931.csv (string, optional)"
},
"user": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"external_id": {
"type": "number"
},
"first_name": {
"type": "string"
},
"last_name": {
"type": "string"
},
"username": {
"type": "string"
},
"professional_email": {
"type": "string"
},
"professional_mobile_phone": {
"type": "string"
},
"professional_phone": {
"type": "string"
},
"role": {
"type": "array"
},
"is_active": {
"type": "boolean"
},
"status": {
"type": "string"
},
"settings": {
"type": "array"
},
"user_photo": {
"type": "string"
}
},
"required": [
"id",
"external_id",
"first_name",
"last_name",
"username",
"professional_email",
"professional_mobile_phone",
"professional_phone",
"role",
"is_active",
"status",
"settings",
"user_photo"
]
}
},
"required": [
"id",
"started_at",
"finished_at",
"result",
"user"
]
}
},
"meta": {
"type": "object",
"properties": {
"pagination": {
"type": "object",
"properties": {
"total": {
"type": "number"
},
"count": {
"type": "number"
},
"per_page": {
"type": "number"
},
"current_page": {
"type": "number"
},
"total_pages": {
"type": "number"
},
"links": {
"type": "object",
"properties": {
"previous": {
"type": "string"
},
"next": {
"type": "string"
}
},
"required": [
"previous",
"next"
]
}
},
"required": [
"total",
"count",
"per_page",
"current_page",
"total_pages",
"links"
],
"additionalProperties": false
}
},
"required": [
"pagination"
]
}
}
}401Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 401
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}403Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 403
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}404Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 404
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}406Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 406
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}422Headers
Content-Type: application/jsonBody
{
"message": "Descriptive error message",
"status_code": 422,
"errors": [
"Error message"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
},
"errors": {
"type": "array"
}
}
}500Headers
Content-Type: application/jsonBody
{
"message": "Internal Error",
"status_code": 500
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}CreatePOST/connector-builder/exports
Create new export map
On creation alias for mapping will be generated automatically
By default all PSO objects from system will be exported using given mapping. There are few limitations:
-
Only latest record from fields marked as listOf will be used
-
The whole composite field cannot be selected in mapping. You must specify each item explicitly
Example URI
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target features>Body
{
"name": {
"en": "Some text",
"fr": "Du texte",
"de": "Setwas Text",
"es": "Algún texto"
},
"description": {
"en": "Some text",
"fr": "Du texte",
"de": "Setwas Text",
"es": "Algún texto"
},
"pso_type": "usr",
"is_active": true,
"language": "en",
"mapping": [
{
"internal": 123,
"external": "Active"
}
],
"conditions": [
{
"type": "group",
"combine_with": "and",
"conditions": [
{
"type": "condition",
"field": "usr_email",
"raw_value": "john.doe@example.com",
"field_value: usr_additional_email": "Hello, world!",
"operator": "Hello, world!"
}
]
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"name": {
"type": "object",
"properties": {
"en": {
"type": "string"
},
"fr": {
"type": "string"
},
"de": {
"type": "string"
},
"es": {
"type": "string"
}
},
"required": [
"en",
"fr",
"de",
"es"
],
"additionalProperties": false
},
"description": {
"type": "object",
"properties": {
"en": {
"type": "string"
},
"fr": {
"type": "string"
},
"de": {
"type": "string"
},
"es": {
"type": "string"
}
},
"required": [
"en",
"fr",
"de",
"es"
],
"additionalProperties": false
},
"pso_type": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"language": {
"type": "string"
},
"mapping": {
"type": "array",
"items": {
"type": "object",
"properties": {
"internal": {
"type": "number"
},
"external": {
"type": "string"
}
},
"required": [
"internal",
"external"
]
}
},
"conditions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"group"
]
},
"combine_with": {
"type": "string",
"enum": [
"and",
"or"
]
},
"conditions": {
"type": "array"
}
},
"required": [
"type",
"combine_with",
"conditions"
]
}
}
},
"required": [
"name",
"description",
"pso_type",
"is_active",
"language",
"mapping"
]
}201Headers
Content-Type: application/jsonBody
{
"data": {
"id": 123,
"alias": "can_be_null"
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"alias": {
"type": "string"
}
},
"required": [
"id"
],
"additionalProperties": false
}
}
}400Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 400
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}401Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 401
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}403Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 403
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}404Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 404
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}406Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 406
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}422Headers
Content-Type: application/jsonBody
{
"message": "Descriptive error message",
"status_code": 422,
"errors": [
"Error message"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
},
"errors": {
"type": "array"
}
}
}500Headers
Content-Type: application/jsonBody
{
"message": "Internal Error",
"status_code": 500
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}UpdatePATCH/connector-builder/exports/{alias}
Update export map
On creation alias for mapping will be generated automatically
By default all PSO objects from system will be exported using given mapping. There are few limitations:
-
Only latest record from fields marked as listOf will be used
-
The whole composite field cannot be selected in mapping. You must specify each item explicitly
Note this endpoint supports partial updates. You may specify ONLY property that need to be changed
Note this endpoint does not support complicated updates. To update nested relations - you need to put all required data
Example URI
- alias
string(required) Example: usr_reportAlias of the Export Mapping.
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target features>Body
{
"name": {
"en": "Some text",
"fr": "Du texte",
"de": "Setwas Text",
"es": "Algún texto"
},
"description": {
"en": "Some text",
"fr": "Du texte",
"de": "Setwas Text",
"es": "Algún texto"
},
"is_active": true,
"language": "en",
"mapping": [
{
"internal": 123,
"external": "Active"
}
],
"conditions": [
{
"type": "group",
"combine_with": "and",
"conditions": [
{
"type": "condition",
"field": "usr_email",
"raw_value": "john.doe@example.com",
"field_value: usr_additional_email": "Hello, world!",
"operator": "Hello, world!"
}
]
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"name": {
"type": "object",
"properties": {
"en": {
"type": "string"
},
"fr": {
"type": "string"
},
"de": {
"type": "string"
},
"es": {
"type": "string"
}
},
"required": [
"en",
"fr",
"de",
"es"
],
"additionalProperties": false
},
"description": {
"type": "object",
"properties": {
"en": {
"type": "string"
},
"fr": {
"type": "string"
},
"de": {
"type": "string"
},
"es": {
"type": "string"
}
},
"required": [
"en",
"fr",
"de",
"es"
],
"additionalProperties": false
},
"is_active": {
"type": "boolean"
},
"language": {
"type": "string"
},
"mapping": {
"type": "array",
"items": {
"type": "object",
"properties": {
"internal": {
"type": "number"
},
"external": {
"type": "string"
}
},
"required": [
"internal",
"external"
]
}
},
"conditions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"group"
]
},
"combine_with": {
"type": "string",
"enum": [
"and",
"or"
]
},
"conditions": {
"type": "array"
}
},
"required": [
"type",
"combine_with",
"conditions"
]
}
}
},
"required": [
"is_active"
]
}200Headers
Content-Type: application/jsonBody
{
"data": {
"id": 123,
"alias": "can_be_null"
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"alias": {
"type": "string"
}
},
"required": [
"id"
],
"additionalProperties": false
}
}
}400Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 400
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}401Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 401
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}403Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 403
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}404Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 404
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}406Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 406
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}422Headers
Content-Type: application/jsonBody
{
"message": "Descriptive error message",
"status_code": 422,
"errors": [
"Error message"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
},
"errors": {
"type": "array"
}
}
}500Headers
Content-Type: application/jsonBody
{
"message": "Internal Error",
"status_code": 500
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}DeleteDELETE/connector-builder/exports/{alias}
Delete export map
On creation alias for mapping will be generated automatically
-
It should NOT ALLOW to delete it if the status is processing (ask for message once it needed)
-
It should drop ONLY map from DB. All generated files and logs must be kept
-
It requires user to have connector_builder_export.delete.* or connector_builder_export.delete.
feature
Example URI
- alias
string(required) Example: usr_reportAlias of the Export Mapping.
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target features>204Headers
Content-Type: application/json400Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 400
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}401Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 401
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}403Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 403
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}404Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 404
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}406Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 406
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}422Headers
Content-Type: application/jsonBody
{
"message": "Descriptive error message",
"status_code": 422,
"errors": [
"Error message"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
},
"errors": {
"type": "array"
}
}
}500Headers
Content-Type: application/jsonBody
{
"message": "Internal Error",
"status_code": 500
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}Imports ¶
ListGET/connector-builder/imports{?name,active,include,sort-by,sort-direction}
Fetch list of data imports
Example URI
- name
string(optional) Example: Data Import to search forSearch by name. Non strict, case-insensitive.
- active
boolean(optional) Example: trueField for filter data imports by
is_activecolumn- sort-by
name, active(optional) Example: titleField to sort data imports by.
- sort-direction
asc, desc(optional) Default: asc Example: ascDirection to order data imports by.
- include
form, files, language(optional) Example: language,formThe way to include relations in the response. Target relations can be comma separated if you want to get few of them
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>200Headers
Content-Type: application/jsonBody
{
"data": [
{
"id": 1,
"name": "Data Import Name",
"description": "Data Import Description",
"is_active": true,
"status": "pending",
"strategies": {
"list_of": "add",
"empty_values": "erase"
},
"form": {
"id": 1,
"name": "Form Name",
"description": "Form Description",
"is_active": true,
"removable": true,
"has_assigned": true,
"fields": [
{
"id": 1,
"name": "Field Name",
"position": 5,
"alias": "usr_first_name",
"has_unique_data": false,
"has_value": true,
"removable": false,
"is_active": true,
"list": false,
"read_only": false,
"required": true,
"type": {
"id": 1,
"name": "Data Type Name",
"alias": "data_type_alias",
"settings": [
{
"id": 1,
"name": "Data Type Setting Name",
"alias": "data_type_setting_alias",
"is_required": true
}
],
"supports_collection": false,
"supports_read_only": false,
"supports_unique": false
},
"category": {
"id": 32,
"alias": "usr_identity",
"position": 5,
"system_required": true,
"name": "Identity",
"description": "...",
"is_active": true,
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
}
},
"domains": [
{
"id": 46,
"alias": "usr_global",
"name": "User Global",
"description": "...",
"is_editable": false,
"is_removable": false,
"is_active": true,
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
}
}
],
"privacy_level": {
"id": 123,
"alias": "public",
"name": "Not Sensitive",
"level": 100
},
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
},
"items": [
{}
],
"options": [
{
"id": 198,
"name": "Chose me!",
"position": 9,
"value": "198",
"is_active": true
}
],
"settings": []
}
],
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
}
},
"language": {
"id": 1,
"alias": "en",
"name": "English"
},
"files": []
}
],
"meta": {
"pagination": {
"total": 238,
"count": 25,
"per_page": 25,
"current_page": 2,
"total_pages": 10,
"links": {
"previous": "http://example.com/api/<endpoint>?page=1",
"next": "http://example.com/api/<endpoint>?page=3"
}
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"status": {
"type": "string",
"enum": [
"pending",
"validation_in_progress",
"validation_success",
"validation_failed",
"validation_warning",
"import_in_progress",
"import_success",
"import_failed",
"import_warning"
]
},
"strategies": {
"type": "object",
"properties": {
"list_of": {
"type": "string",
"enum": [
"add",
"replace"
]
},
"empty_values": {
"type": "string",
"enum": [
"erase",
"ignore"
]
}
},
"required": [
"list_of",
"empty_values"
],
"additionalProperties": false
},
"form": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"removable": {
"type": "boolean"
},
"has_assigned": {
"type": "boolean"
},
"fields": {
"type": "array"
},
"pso_type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"system_required": {
"type": "boolean"
},
"creation_form_instance_id": {
"type": "number"
},
"profile_form_instance_id": {
"type": "number"
}
},
"required": [
"id",
"name",
"alias",
"description",
"is_active",
"system_required",
"creation_form_instance_id",
"profile_form_instance_id"
]
}
},
"required": [
"id",
"name",
"description",
"is_active",
"removable",
"has_assigned"
]
},
"language": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"alias": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"id",
"alias",
"name"
]
},
"files": {
"type": "array"
}
},
"required": [
"id",
"name",
"description",
"is_active",
"status",
"strategies"
]
}
},
"meta": {
"type": "object",
"properties": {
"pagination": {
"type": "object",
"properties": {
"total": {
"type": "number"
},
"count": {
"type": "number"
},
"per_page": {
"type": "number"
},
"current_page": {
"type": "number"
},
"total_pages": {
"type": "number"
},
"links": {
"type": "object",
"properties": {
"previous": {
"type": "string"
},
"next": {
"type": "string"
}
},
"required": [
"previous",
"next"
]
}
},
"required": [
"total",
"count",
"per_page",
"current_page",
"total_pages",
"links"
],
"additionalProperties": false
}
},
"required": [
"pagination"
]
}
}
}401Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 401
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}403Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 403
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}404Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 404
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}406Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 406
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}422Headers
Content-Type: application/jsonBody
{
"message": "Descriptive error message",
"status_code": 422,
"errors": [
"Error message"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
},
"errors": {
"type": "array"
}
}
}500Headers
Content-Type: application/jsonBody
{
"message": "Internal Error",
"status_code": 500
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}ShowGET/connector-builder/imports/{id}{?include}
Fetch specified data import
Example URI
- id
number(required) Example: 1Id of the Data Import.
- include
form, files, language(optional) Example: language,formThe way to include relations in the response. Target relations can be comma separated if you want to get few of them
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <comma separated features>200Headers
Content-Type: application/jsonBody
{
"data": {
"id": 1,
"name": "Data Import Name",
"description": "Data Import Description",
"is_active": true,
"status": "pending",
"strategies": {
"list_of": "add",
"empty_values": "erase"
},
"form": {
"id": 1,
"name": "Form Name",
"description": "Form Description",
"is_active": true,
"removable": true,
"has_assigned": true,
"fields": [
{
"id": 1,
"name": "Field Name",
"position": 5,
"alias": "usr_first_name",
"has_unique_data": false,
"has_value": true,
"removable": false,
"is_active": true,
"list": false,
"read_only": false,
"required": true,
"type": {
"id": 1,
"name": "Data Type Name",
"alias": "data_type_alias",
"settings": [
{
"id": 1,
"name": "Data Type Setting Name",
"alias": "data_type_setting_alias",
"is_required": true
}
],
"supports_collection": false,
"supports_read_only": false,
"supports_unique": false
},
"category": {
"id": 32,
"alias": "usr_identity",
"position": 5,
"system_required": true,
"name": "Identity",
"description": "...",
"is_active": true,
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
}
},
"domains": [
{
"id": 46,
"alias": "usr_global",
"name": "User Global",
"description": "...",
"is_editable": false,
"is_removable": false,
"is_active": true,
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
}
}
],
"privacy_level": {
"id": 123,
"alias": "public",
"name": "Not Sensitive",
"level": 100
},
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
},
"items": [
{}
],
"options": [
{
"id": 198,
"name": "Chose me!",
"position": 9,
"value": "198",
"is_active": true
}
],
"settings": []
}
],
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
}
},
"language": {
"id": 1,
"alias": "en",
"name": "English"
},
"files": []
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"status": {
"type": "string",
"enum": [
"pending",
"validation_in_progress",
"validation_success",
"validation_failed",
"validation_warning",
"import_in_progress",
"import_success",
"import_failed",
"import_warning"
]
},
"strategies": {
"type": "object",
"properties": {
"list_of": {
"type": "string",
"enum": [
"add",
"replace"
]
},
"empty_values": {
"type": "string",
"enum": [
"erase",
"ignore"
]
}
},
"required": [
"list_of",
"empty_values"
],
"additionalProperties": false
},
"form": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"removable": {
"type": "boolean"
},
"has_assigned": {
"type": "boolean"
},
"fields": {
"type": "array"
},
"pso_type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"system_required": {
"type": "boolean"
},
"creation_form_instance_id": {
"type": "number"
},
"profile_form_instance_id": {
"type": "number"
}
},
"required": [
"id",
"name",
"alias",
"description",
"is_active",
"system_required",
"creation_form_instance_id",
"profile_form_instance_id"
]
}
},
"required": [
"id",
"name",
"description",
"is_active",
"removable",
"has_assigned"
]
},
"language": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"alias": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"id",
"alias",
"name"
]
},
"files": {
"type": "array"
}
},
"required": [
"id",
"name",
"description",
"is_active",
"status",
"strategies"
],
"additionalProperties": false
}
}
}401Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 401
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}403Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 403
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}404Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 404
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}406Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 406
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}422Headers
Content-Type: application/jsonBody
{
"message": "Descriptive error message",
"status_code": 422,
"errors": [
"Error message"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
},
"errors": {
"type": "array"
}
}
}500Headers
Content-Type: application/jsonBody
{
"message": "Internal Error",
"status_code": 500
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}CreatePOST/connector-builder/imports
Create new data import
Example URI
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target features>Body
{
"name": {
"en": "Some text",
"fr": "Du texte",
"de": "Setwas Text",
"es": "Algún texto"
},
"description": {
"en": "Some text",
"fr": "Du texte",
"de": "Setwas Text",
"es": "Algún texto"
},
"form": 1,
"language": "en",
"is_active": true,
"strategies": {
"list_of": "add",
"empty_values": "erase"
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"name": {
"type": "object",
"properties": {
"en": {
"type": "string"
},
"fr": {
"type": "string"
},
"de": {
"type": "string"
},
"es": {
"type": "string"
}
},
"required": [
"en",
"fr",
"de",
"es"
]
},
"description": {
"type": "object",
"properties": {
"en": {
"type": "string"
},
"fr": {
"type": "string"
},
"de": {
"type": "string"
},
"es": {
"type": "string"
}
},
"required": [
"en",
"fr",
"de",
"es"
]
},
"form": {
"type": "number"
},
"language": {
"type": "string",
"description": "alias of available in system language"
},
"is_active": {
"type": "boolean"
},
"strategies": {
"type": "object",
"properties": {
"list_of": {
"type": "string",
"enum": [
"add",
"replace"
]
},
"empty_values": {
"type": "string",
"enum": [
"erase",
"ignore"
]
}
},
"required": [
"list_of",
"empty_values"
],
"additionalProperties": false
}
},
"required": [
"name",
"description",
"form",
"language",
"is_active",
"strategies"
]
}201Headers
Content-Type: application/jsonBody
{
"data": {
"id": 1,
"name": "Data Import Name",
"description": "Data Import Description",
"is_active": true,
"status": "pending",
"strategies": {
"list_of": "add",
"empty_values": "erase"
},
"form": {
"id": 1,
"name": "Form Name",
"description": "Form Description",
"is_active": true,
"removable": true,
"has_assigned": true,
"fields": [
{
"id": 1,
"name": "Field Name",
"position": 5,
"alias": "usr_first_name",
"has_unique_data": false,
"has_value": true,
"removable": false,
"is_active": true,
"list": false,
"read_only": false,
"required": true,
"type": {
"id": 1,
"name": "Data Type Name",
"alias": "data_type_alias",
"settings": [
{
"id": 1,
"name": "Data Type Setting Name",
"alias": "data_type_setting_alias",
"is_required": true
}
],
"supports_collection": false,
"supports_read_only": false,
"supports_unique": false
},
"category": {
"id": 32,
"alias": "usr_identity",
"position": 5,
"system_required": true,
"name": "Identity",
"description": "...",
"is_active": true,
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
}
},
"domains": [
{
"id": 46,
"alias": "usr_global",
"name": "User Global",
"description": "...",
"is_editable": false,
"is_removable": false,
"is_active": true,
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
}
}
],
"privacy_level": {
"id": 123,
"alias": "public",
"name": "Not Sensitive",
"level": 100
},
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
},
"items": [
{}
],
"options": [
{
"id": 198,
"name": "Chose me!",
"position": 9,
"value": "198",
"is_active": true
}
],
"settings": []
}
],
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
}
},
"language": {
"id": 1,
"alias": "en",
"name": "English"
},
"files": []
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"status": {
"type": "string",
"enum": [
"pending",
"validation_in_progress",
"validation_success",
"validation_failed",
"validation_warning",
"import_in_progress",
"import_success",
"import_failed",
"import_warning"
]
},
"strategies": {
"type": "object",
"properties": {
"list_of": {
"type": "string",
"enum": [
"add",
"replace"
]
},
"empty_values": {
"type": "string",
"enum": [
"erase",
"ignore"
]
}
},
"required": [
"list_of",
"empty_values"
],
"additionalProperties": false
},
"form": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"removable": {
"type": "boolean"
},
"has_assigned": {
"type": "boolean"
},
"fields": {
"type": "array"
},
"pso_type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"system_required": {
"type": "boolean"
},
"creation_form_instance_id": {
"type": "number"
},
"profile_form_instance_id": {
"type": "number"
}
},
"required": [
"id",
"name",
"alias",
"description",
"is_active",
"system_required",
"creation_form_instance_id",
"profile_form_instance_id"
]
}
},
"required": [
"id",
"name",
"description",
"is_active",
"removable",
"has_assigned"
]
},
"language": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"alias": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"id",
"alias",
"name"
]
},
"files": {
"type": "array"
}
},
"required": [
"id",
"name",
"description",
"is_active",
"status",
"strategies"
],
"additionalProperties": false
}
}
}400Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 400
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}401Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 401
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}403Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 403
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}404Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 404
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}406Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 406
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}422Headers
Content-Type: application/jsonBody
{
"message": "Descriptive error message",
"status_code": 422,
"errors": [
"Error message"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
},
"errors": {
"type": "array"
}
}
}500Headers
Content-Type: application/jsonBody
{
"message": "Internal Error",
"status_code": 500
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}UpdatePATCH/connector-builder/imports/{id}
Update data import
Example URI
- id
number(required) Example: 1Id of the Data Import.
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target features>Body
{
"name": {
"en": "Some text",
"fr": "Du texte",
"de": "Setwas Text",
"es": "Algún texto"
},
"description": {
"en": "Some text",
"fr": "Du texte",
"de": "Setwas Text",
"es": "Algún texto"
},
"form": 1,
"language": "en",
"is_active": true,
"strategies": {
"list_of": "add",
"empty_values": "erase"
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"name": {
"type": "object",
"properties": {
"en": {
"type": "string"
},
"fr": {
"type": "string"
},
"de": {
"type": "string"
},
"es": {
"type": "string"
}
},
"required": [
"en",
"fr",
"de",
"es"
]
},
"description": {
"type": "object",
"properties": {
"en": {
"type": "string"
},
"fr": {
"type": "string"
},
"de": {
"type": "string"
},
"es": {
"type": "string"
}
},
"required": [
"en",
"fr",
"de",
"es"
]
},
"form": {
"type": "number"
},
"language": {
"type": "string",
"description": "alias of available in system language"
},
"is_active": {
"type": "boolean"
},
"strategies": {
"type": "object",
"properties": {
"list_of": {
"type": "string",
"enum": [
"add",
"replace"
]
},
"empty_values": {
"type": "string",
"enum": [
"erase",
"ignore"
]
}
}
}
}
}200Headers
Content-Type: application/jsonBody
{
"data": {
"id": 1,
"name": "Data Import Name",
"description": "Data Import Description",
"is_active": true,
"status": "pending",
"strategies": {
"list_of": "add",
"empty_values": "erase"
},
"form": {
"id": 1,
"name": "Form Name",
"description": "Form Description",
"is_active": true,
"removable": true,
"has_assigned": true,
"fields": [
{
"id": 1,
"name": "Field Name",
"position": 5,
"alias": "usr_first_name",
"has_unique_data": false,
"has_value": true,
"removable": false,
"is_active": true,
"list": false,
"read_only": false,
"required": true,
"type": {
"id": 1,
"name": "Data Type Name",
"alias": "data_type_alias",
"settings": [
{
"id": 1,
"name": "Data Type Setting Name",
"alias": "data_type_setting_alias",
"is_required": true
}
],
"supports_collection": false,
"supports_read_only": false,
"supports_unique": false
},
"category": {
"id": 32,
"alias": "usr_identity",
"position": 5,
"system_required": true,
"name": "Identity",
"description": "...",
"is_active": true,
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
}
},
"domains": [
{
"id": 46,
"alias": "usr_global",
"name": "User Global",
"description": "...",
"is_editable": false,
"is_removable": false,
"is_active": true,
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
}
}
],
"privacy_level": {
"id": 123,
"alias": "public",
"name": "Not Sensitive",
"level": 100
},
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
},
"items": [
{}
],
"options": [
{
"id": 198,
"name": "Chose me!",
"position": 9,
"value": "198",
"is_active": true
}
],
"settings": []
}
],
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
}
},
"language": {
"id": 1,
"alias": "en",
"name": "English"
},
"files": []
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"status": {
"type": "string",
"enum": [
"pending",
"validation_in_progress",
"validation_success",
"validation_failed",
"validation_warning",
"import_in_progress",
"import_success",
"import_failed",
"import_warning"
]
},
"strategies": {
"type": "object",
"properties": {
"list_of": {
"type": "string",
"enum": [
"add",
"replace"
]
},
"empty_values": {
"type": "string",
"enum": [
"erase",
"ignore"
]
}
},
"required": [
"list_of",
"empty_values"
],
"additionalProperties": false
},
"form": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"removable": {
"type": "boolean"
},
"has_assigned": {
"type": "boolean"
},
"fields": {
"type": "array"
},
"pso_type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"system_required": {
"type": "boolean"
},
"creation_form_instance_id": {
"type": "number"
},
"profile_form_instance_id": {
"type": "number"
}
},
"required": [
"id",
"name",
"alias",
"description",
"is_active",
"system_required",
"creation_form_instance_id",
"profile_form_instance_id"
]
}
},
"required": [
"id",
"name",
"description",
"is_active",
"removable",
"has_assigned"
]
},
"language": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"alias": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"id",
"alias",
"name"
]
},
"files": {
"type": "array"
}
},
"required": [
"id",
"name",
"description",
"is_active",
"status",
"strategies"
],
"additionalProperties": false
}
}
}400Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 400
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}401Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 401
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}403Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 403
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}404Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 404
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}406Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 406
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}422Headers
Content-Type: application/jsonBody
{
"message": "Descriptive error message",
"status_code": 422,
"errors": [
"Error message"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
},
"errors": {
"type": "array"
}
}
}500Headers
Content-Type: application/jsonBody
{
"message": "Internal Error",
"status_code": 500
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}DeleteDELETE/connector-builder/imports/{id}
Delete data import
Example URI
- id
number(required) Example: 1Id of the data Import.
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target features>204Headers
Content-Type: application/json400Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 400
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}401Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 401
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}403Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 403
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}404Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 404
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}406Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 406
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}422Headers
Content-Type: application/jsonBody
{
"message": "Descriptive error message",
"status_code": 422,
"errors": [
"Error message"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
},
"errors": {
"type": "array"
}
}
}500Headers
Content-Type: application/jsonBody
{
"message": "Internal Error",
"status_code": 500
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}GeneratePOST/connector-builder/imports/{id}/generate
Generate .xls template for import
It returns file stream with generated template file.
Example URI
- id
number(required) Example: 1Id of the Data Import.
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <comma separated features>200Headers
Content-Type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet401Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 401
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}403Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 403
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}404Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 404
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}406Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 406
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}422Headers
Content-Type: application/jsonBody
{
"message": "Descriptive error message",
"status_code": 422,
"errors": [
"Error message"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
},
"errors": {
"type": "array"
}
}
}500Headers
Content-Type: application/jsonBody
{
"message": "Internal Error",
"status_code": 500
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}ValidatePOST/connector-builder/imports/{id}/validate
Upload and validate filled template template
Upload filled .xls template and plan it to validate. It not available if any other file in process(validation/submission) at the moment.
Example URI
- id
number(required) Example: 1Id of the Data Import.
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <comma separated features>Body
{
"name": "image.jpg",
"file": {}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"name": {
"type": "string"
},
"file": {
"type": "object",
"properties": {},
"description": "file to upload. Max size 5 megabytes."
}
},
"required": [
"file"
]
}201Headers
Content-Type: application/jsonBody
{
"data": {
"id": 1,
"name": "Data Import Name",
"description": "Data Import Description",
"is_active": true,
"status": "pending",
"strategies": {
"list_of": "add",
"empty_values": "erase"
},
"form": {
"id": 1,
"name": "Form Name",
"description": "Form Description",
"is_active": true,
"removable": true,
"has_assigned": true,
"fields": [
{
"id": 1,
"name": "Field Name",
"position": 5,
"alias": "usr_first_name",
"has_unique_data": false,
"has_value": true,
"removable": false,
"is_active": true,
"list": false,
"read_only": false,
"required": true,
"type": {
"id": 1,
"name": "Data Type Name",
"alias": "data_type_alias",
"settings": [
{
"id": 1,
"name": "Data Type Setting Name",
"alias": "data_type_setting_alias",
"is_required": true
}
],
"supports_collection": false,
"supports_read_only": false,
"supports_unique": false
},
"category": {
"id": 32,
"alias": "usr_identity",
"position": 5,
"system_required": true,
"name": "Identity",
"description": "...",
"is_active": true,
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
}
},
"domains": [
{
"id": 46,
"alias": "usr_global",
"name": "User Global",
"description": "...",
"is_editable": false,
"is_removable": false,
"is_active": true,
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
}
}
],
"privacy_level": {
"id": 123,
"alias": "public",
"name": "Not Sensitive",
"level": 100
},
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
},
"items": [
{}
],
"options": [
{
"id": 198,
"name": "Chose me!",
"position": 9,
"value": "198",
"is_active": true
}
],
"settings": []
}
],
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
}
},
"language": {
"id": 1,
"alias": "en",
"name": "English"
},
"files": []
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"status": {
"type": "string",
"enum": [
"pending",
"validation_in_progress",
"validation_success",
"validation_failed",
"validation_warning",
"import_in_progress",
"import_success",
"import_failed",
"import_warning"
]
},
"strategies": {
"type": "object",
"properties": {
"list_of": {
"type": "string",
"enum": [
"add",
"replace"
]
},
"empty_values": {
"type": "string",
"enum": [
"erase",
"ignore"
]
}
},
"required": [
"list_of",
"empty_values"
],
"additionalProperties": false
},
"form": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"removable": {
"type": "boolean"
},
"has_assigned": {
"type": "boolean"
},
"fields": {
"type": "array"
},
"pso_type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"system_required": {
"type": "boolean"
},
"creation_form_instance_id": {
"type": "number"
},
"profile_form_instance_id": {
"type": "number"
}
},
"required": [
"id",
"name",
"alias",
"description",
"is_active",
"system_required",
"creation_form_instance_id",
"profile_form_instance_id"
]
}
},
"required": [
"id",
"name",
"description",
"is_active",
"removable",
"has_assigned"
]
},
"language": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"alias": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"id",
"alias",
"name"
]
},
"files": {
"type": "array"
}
},
"required": [
"id",
"name",
"description",
"is_active",
"status",
"strategies"
],
"additionalProperties": false
}
}
}401Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 401
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}403Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 403
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}404Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 404
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}406Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 406
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}422Headers
Content-Type: application/jsonBody
{
"message": "Descriptive error message",
"status_code": 422,
"errors": [
"Error message"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
},
"errors": {
"type": "array"
}
}
}500Headers
Content-Type: application/jsonBody
{
"message": "Internal Error",
"status_code": 500
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}Run importPOST/connector-builder/imports/{id}/run
Run import process
It plan import data from last valid(success or warning) file.
Example URI
- id
number(required) Example: 1Id of the Data Import.
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <comma separated features>204Headers
Content-Type: application/json401Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 401
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}403Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 403
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}404Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 404
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}406Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 406
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}422Headers
Content-Type: application/jsonBody
{
"message": "Descriptive error message",
"status_code": 422,
"errors": [
"Error message"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
},
"errors": {
"type": "array"
}
}
}500Headers
Content-Type: application/jsonBody
{
"message": "Internal Error",
"status_code": 500
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}Document Generators ¶
Document Generators generate pdf files via specified document templates and store them in specified user profile fields
Document Generators ¶
Common ListGET/document-generators{?title,pso-type,active,sort-by,sort-direction,page,per-page,no-pagination}
Get list of document generators matches specified filters
Example URI
- title
string(optional) Example: Document generator name to searchSearch by title. Non strict, case-insensitive.
- pso-type
string(optional) Example: usrPso Type trigram to filter document generators
- active
boolean(optional) Example: trueField for filter exports by
is_activecolumn- sort-by
name, created_at(required) Example: name- sort-direction
asc, desc(required) Example: asc- page
number(required) Example: 1Page number.
1by default- per-page
number(required) Example: 10Number of items per page,
25by default- no-pagination
boolean(required) Example: falseif presented and positive pagination will not be applied. All available items will be returned.
Note: it may have significant impact on the performance
Note: once this option positive and presented -
metaattribute with pagination data will be omit in response
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>200Headers
Content-Type: application/jsonBody
{
"data": [
{
"title": "document generator name",
"description": "document generator description",
"is_active": true,
"should_be_signed": false,
"is_processing": false,
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
},
"template_id": 1,
"target_population": [
{
"type": "all",
"details": {
"dynamic": true,
"includes": [
"group_a"
],
"excludes": [
"group_b",
"group_c"
]
}
}
],
"storage_field": "alias of field",
"excluded_block_ids": [
"block001",
"block002"
]
}
],
"meta": {
"pagination": {
"total": 238,
"count": 25,
"per_page": 25,
"current_page": 2,
"total_pages": 10,
"links": {
"previous": "http://example.com/api/<endpoint>?page=1",
"next": "http://example.com/api/<endpoint>?page=3"
}
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"title": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"should_be_signed": {
"type": "boolean"
},
"is_processing": {
"type": "boolean"
},
"pso_type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"system_required": {
"type": "boolean"
},
"creation_form_instance_id": {
"type": "number"
},
"profile_form_instance_id": {
"type": "number"
}
},
"required": [
"id",
"name",
"alias",
"description",
"is_active",
"system_required",
"creation_form_instance_id",
"profile_form_instance_id"
],
"additionalProperties": false
},
"template_id": {
"type": "number"
},
"target_population": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"all",
"group",
"pso",
"relation"
]
},
"details": {
"anyOf": [
{
"type": "object",
"properties": {
"dynamic": {
"type": "boolean"
},
"includes": {
"type": "array"
},
"excludes": {
"type": "array"
}
},
"required": [
"dynamic",
"includes",
"excludes"
]
},
{
"type": "array",
"enum": [
[],
[]
]
}
],
"type": "null"
}
},
"required": [
"type",
"details"
]
}
},
"storage_field": {
"type": "string"
},
"excluded_block_ids": {
"type": "array"
}
},
"required": [
"title",
"description",
"is_active",
"should_be_signed",
"is_processing",
"template_id",
"storage_field"
]
}
},
"meta": {
"type": "object",
"properties": {
"pagination": {
"type": "object",
"properties": {
"total": {
"type": "number"
},
"count": {
"type": "number"
},
"per_page": {
"type": "number"
},
"current_page": {
"type": "number"
},
"total_pages": {
"type": "number"
},
"links": {
"type": "object",
"properties": {
"previous": {
"type": "string"
},
"next": {
"type": "string"
}
},
"required": [
"previous",
"next"
]
}
},
"required": [
"total",
"count",
"per_page",
"current_page",
"total_pages",
"links"
],
"additionalProperties": false
}
},
"required": [
"pagination"
]
}
}
}401Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 401
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}403Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 403
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}404Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 404
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}406Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 406
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}422Headers
Content-Type: application/jsonBody
{
"message": "Descriptive error message",
"status_code": 422,
"errors": [
"Error message"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
},
"errors": {
"type": "array"
}
}
}500Headers
Content-Type: application/jsonBody
{
"message": "Internal Error",
"status_code": 500
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}ShowGET/document-generators/{id}
Fetch single document generator
Example URI
- id
number(required) Example: queryId of the Document Generator.
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: '*'200Headers
Content-Type: application/jsonBody
{
"data": {
"title": "document generator name",
"description": "document generator description",
"is_active": true,
"should_be_signed": false,
"is_processing": false,
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
},
"template_id": 1,
"target_population": [
{
"type": "all",
"details": {
"dynamic": true,
"includes": [
"group_a"
],
"excludes": [
"group_b",
"group_c"
]
}
}
],
"storage_field": "alias of field",
"excluded_block_ids": [
"block001",
"block002"
]
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"title": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"should_be_signed": {
"type": "boolean"
},
"is_processing": {
"type": "boolean"
},
"pso_type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"system_required": {
"type": "boolean"
},
"creation_form_instance_id": {
"type": "number"
},
"profile_form_instance_id": {
"type": "number"
}
},
"required": [
"id",
"name",
"alias",
"description",
"is_active",
"system_required",
"creation_form_instance_id",
"profile_form_instance_id"
],
"additionalProperties": false
},
"template_id": {
"type": "number"
},
"target_population": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"all",
"group",
"pso",
"relation"
]
},
"details": {
"anyOf": [
{
"type": "object",
"properties": {
"dynamic": {
"type": "boolean"
},
"includes": {
"type": "array"
},
"excludes": {
"type": "array"
}
},
"required": [
"dynamic",
"includes",
"excludes"
]
},
{
"type": "array",
"enum": [
[],
[]
]
}
],
"type": "null"
}
},
"required": [
"type",
"details"
]
}
},
"storage_field": {
"type": "string"
},
"excluded_block_ids": {
"type": "array"
}
},
"required": [
"title",
"description",
"is_active",
"should_be_signed",
"is_processing",
"template_id",
"target_population",
"storage_field"
],
"additionalProperties": false
}
}
}401Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 401
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}403Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 403
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}404Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 404
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}406Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 406
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}422Headers
Content-Type: application/jsonBody
{
"message": "Descriptive error message",
"status_code": 422,
"errors": [
"Error message"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
},
"errors": {
"type": "array"
}
}
}500Headers
Content-Type: application/jsonBody
{
"message": "Internal Error",
"status_code": 500
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}CreatePOST/document-generators
Create Document Generator
Example URI
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: '*'Body
{
"title": {
"en": "Some text",
"fr": "Du texte",
"de": "Setwas Text",
"es": "Algún texto"
},
"description": {
"en": "Some text",
"fr": "Du texte",
"de": "Setwas Text",
"es": "Algún texto"
},
"is_active": true,
"should_be_signed": false,
"storage_field": "alias of field",
"excluded_block_ids": [
"block001",
"block002"
],
"target_population": [
{
"type": "all",
"details": {
"dynamic": true,
"includes": [
"group_a"
],
"excludes": [
"group_b",
"group_c"
]
}
}
],
"template_id": 1,
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"title": {
"type": "object",
"properties": {
"en": {
"type": "string"
},
"fr": {
"type": "string"
},
"de": {
"type": "string"
},
"es": {
"type": "string"
}
},
"required": [
"en",
"fr",
"de",
"es"
]
},
"description": {
"type": "object",
"properties": {
"en": {
"type": "string"
},
"fr": {
"type": "string"
},
"de": {
"type": "string"
},
"es": {
"type": "string"
}
},
"required": [
"en",
"fr",
"de",
"es"
]
},
"is_active": {
"type": "boolean"
},
"should_be_signed": {
"type": "boolean"
},
"storage_field": {
"type": "string"
},
"excluded_block_ids": {
"type": "array"
},
"target_population": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"all",
"group",
"pso",
"relation"
]
},
"details": {
"anyOf": [
{
"type": "object",
"properties": {
"dynamic": {
"type": "boolean"
},
"includes": {
"type": "array"
},
"excludes": {
"type": "array"
}
},
"required": [
"dynamic",
"includes",
"excludes"
]
},
{
"type": "array",
"enum": [
[],
[]
]
}
],
"type": "null"
}
},
"required": [
"type",
"details"
]
}
},
"template_id": {
"type": "number"
},
"pso_type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"system_required": {
"type": "boolean"
},
"creation_form_instance_id": {
"type": "number"
},
"profile_form_instance_id": {
"type": "number"
}
},
"required": [
"id",
"name",
"alias",
"description",
"is_active",
"system_required",
"creation_form_instance_id",
"profile_form_instance_id"
],
"additionalProperties": false
}
},
"required": [
"title",
"description",
"is_active",
"should_be_signed",
"storage_field",
"template_id"
]
}201Headers
Content-Type: application/jsonBody
{
"data": {
"title": "document generator name",
"description": "document generator description",
"is_active": true,
"should_be_signed": false,
"is_processing": false,
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
},
"template_id": 1,
"target_population": [
{
"type": "all",
"details": {
"dynamic": true,
"includes": [
"group_a"
],
"excludes": [
"group_b",
"group_c"
]
}
}
],
"storage_field": "alias of field",
"excluded_block_ids": [
"block001",
"block002"
]
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"title": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"should_be_signed": {
"type": "boolean"
},
"is_processing": {
"type": "boolean"
},
"pso_type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"system_required": {
"type": "boolean"
},
"creation_form_instance_id": {
"type": "number"
},
"profile_form_instance_id": {
"type": "number"
}
},
"required": [
"id",
"name",
"alias",
"description",
"is_active",
"system_required",
"creation_form_instance_id",
"profile_form_instance_id"
],
"additionalProperties": false
},
"template_id": {
"type": "number"
},
"target_population": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"all",
"group",
"pso",
"relation"
]
},
"details": {
"anyOf": [
{
"type": "object",
"properties": {
"dynamic": {
"type": "boolean"
},
"includes": {
"type": "array"
},
"excludes": {
"type": "array"
}
},
"required": [
"dynamic",
"includes",
"excludes"
]
},
{
"type": "array",
"enum": [
[],
[]
]
}
],
"type": "null"
}
},
"required": [
"type",
"details"
]
}
},
"storage_field": {
"type": "string"
},
"excluded_block_ids": {
"type": "array"
}
},
"required": [
"title",
"description",
"is_active",
"should_be_signed",
"is_processing",
"template_id",
"target_population",
"storage_field"
],
"additionalProperties": false
}
}
}400Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 400
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}401Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 401
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}403Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 403
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}404Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 404
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}406Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 406
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}422Headers
Content-Type: application/jsonBody
{
"message": "Descriptive error message",
"status_code": 422,
"errors": [
"Error message"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
},
"errors": {
"type": "array"
}
}
}500Headers
Content-Type: application/jsonBody
{
"message": "Internal Error",
"status_code": 500
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}UpdatePATCH/document-generators/{id}
Update Document Generator
Example URI
- id
number(required) Example: 123Id of the Document Generator.
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>Body
{
"title": {
"en": "Some text",
"fr": "Du texte",
"de": "Setwas Text",
"es": "Algún texto"
},
"description": {
"en": "Some text",
"fr": "Du texte",
"de": "Setwas Text",
"es": "Algún texto"
},
"is_active": true,
"should_be_signed": false,
"storage_field": "alias of field",
"excluded_block_ids": [
"block001",
"block002"
],
"target_population": [
{
"type": "all",
"details": {
"dynamic": true,
"includes": [
"group_a"
],
"excludes": [
"group_b",
"group_c"
]
}
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"title": {
"type": "object",
"properties": {
"en": {
"type": "string"
},
"fr": {
"type": "string"
},
"de": {
"type": "string"
},
"es": {
"type": "string"
}
},
"required": [
"en",
"fr",
"de",
"es"
]
},
"description": {
"type": "object",
"properties": {
"en": {
"type": "string"
},
"fr": {
"type": "string"
},
"de": {
"type": "string"
},
"es": {
"type": "string"
}
},
"required": [
"en",
"fr",
"de",
"es"
]
},
"is_active": {
"type": "boolean"
},
"should_be_signed": {
"type": "boolean"
},
"storage_field": {
"type": "string"
},
"excluded_block_ids": {
"type": "array"
},
"target_population": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"all",
"group",
"pso",
"relation"
]
},
"details": {
"anyOf": [
{
"type": "object",
"properties": {
"dynamic": {
"type": "boolean"
},
"includes": {
"type": "array"
},
"excludes": {
"type": "array"
}
},
"required": [
"dynamic",
"includes",
"excludes"
]
},
{
"type": "array",
"enum": [
[],
[]
]
}
],
"type": "null"
}
},
"required": [
"type",
"details"
]
}
}
},
"required": [
"title",
"description",
"is_active",
"should_be_signed",
"storage_field"
]
}202Headers
Content-Type: application/jsonBody
{
"data": {
"title": "document generator name",
"description": "document generator description",
"is_active": true,
"should_be_signed": false,
"is_processing": false,
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
},
"template_id": 1,
"target_population": [
{
"type": "all",
"details": {
"dynamic": true,
"includes": [
"group_a"
],
"excludes": [
"group_b",
"group_c"
]
}
}
],
"storage_field": "alias of field",
"excluded_block_ids": [
"block001",
"block002"
]
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"title": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"should_be_signed": {
"type": "boolean"
},
"is_processing": {
"type": "boolean"
},
"pso_type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"system_required": {
"type": "boolean"
},
"creation_form_instance_id": {
"type": "number"
},
"profile_form_instance_id": {
"type": "number"
}
},
"required": [
"id",
"name",
"alias",
"description",
"is_active",
"system_required",
"creation_form_instance_id",
"profile_form_instance_id"
],
"additionalProperties": false
},
"template_id": {
"type": "number"
},
"target_population": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"all",
"group",
"pso",
"relation"
]
},
"details": {
"anyOf": [
{
"type": "object",
"properties": {
"dynamic": {
"type": "boolean"
},
"includes": {
"type": "array"
},
"excludes": {
"type": "array"
}
},
"required": [
"dynamic",
"includes",
"excludes"
]
},
{
"type": "array",
"enum": [
[],
[]
]
}
],
"type": "null"
}
},
"required": [
"type",
"details"
]
}
},
"storage_field": {
"type": "string"
},
"excluded_block_ids": {
"type": "array"
}
},
"required": [
"title",
"description",
"is_active",
"should_be_signed",
"is_processing",
"template_id",
"target_population",
"storage_field"
],
"additionalProperties": false
}
}
}400Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 400
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}401Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 401
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}403Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 403
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}404Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 404
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}406Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 406
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}422Headers
Content-Type: application/jsonBody
{
"message": "Descriptive error message",
"status_code": 422,
"errors": [
"Error message"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
},
"errors": {
"type": "array"
}
}
}500Headers
Content-Type: application/jsonBody
{
"message": "Internal Error",
"status_code": 500
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}DeleteDELETE/document-generators/{id}
Delete Document Generator
Example URI
- id
number(required) Example: 123Id of the Document Generator
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: '*'204Headers
Content-Type: application/json401Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 401
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}403Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 403
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}404Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 404
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}406Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 406
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}422Headers
Content-Type: application/jsonBody
{
"message": "Descriptive error message",
"status_code": 422,
"errors": [
"Error message"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
},
"errors": {
"type": "array"
}
}
}500Headers
Content-Type: application/jsonBody
{
"message": "Internal Error",
"status_code": 500
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}GeneratePOST/document-generators/{id}/generate
Generate document from Document Generator
Example URI
- id
number(required) Example: 123Id of the Document Generator.
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: '*'202Headers
Content-Type: application/json400Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 400
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}401Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 401
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}403Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 403
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}404Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 404
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}406Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 406
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}422Headers
Content-Type: application/jsonBody
{
"message": "Descriptive error message",
"status_code": 422,
"errors": [
"Error message"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
},
"errors": {
"type": "array"
}
}
}500Headers
Content-Type: application/jsonBody
{
"message": "Internal Error",
"status_code": 500
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}CopyPOST/document-generators/{id}/copy
Copy Document Generator
Example URI
- id
number(required) Example: 123Id of the Document Generator.
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>Body
{
"title": {
"en": "Some text",
"fr": "Du texte",
"de": "Setwas Text",
"es": "Algún texto"
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"title": {
"type": "object",
"properties": {
"en": {
"type": "string"
},
"fr": {
"type": "string"
},
"de": {
"type": "string"
},
"es": {
"type": "string"
}
},
"required": [
"en",
"fr",
"de",
"es"
]
}
}
}202Headers
Content-Type: application/jsonBody
{
"data": {
"title": "document generator name",
"description": "document generator description",
"is_active": true,
"should_be_signed": false,
"is_processing": false,
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
},
"template_id": 1,
"target_population": [
{
"type": "all",
"details": {
"dynamic": true,
"includes": [
"group_a"
],
"excludes": [
"group_b",
"group_c"
]
}
}
],
"storage_field": "alias of field",
"excluded_block_ids": [
"block001",
"block002"
]
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"title": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"should_be_signed": {
"type": "boolean"
},
"is_processing": {
"type": "boolean"
},
"pso_type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"system_required": {
"type": "boolean"
},
"creation_form_instance_id": {
"type": "number"
},
"profile_form_instance_id": {
"type": "number"
}
},
"required": [
"id",
"name",
"alias",
"description",
"is_active",
"system_required",
"creation_form_instance_id",
"profile_form_instance_id"
],
"additionalProperties": false
},
"template_id": {
"type": "number"
},
"target_population": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"all",
"group",
"pso",
"relation"
]
},
"details": {
"anyOf": [
{
"type": "object",
"properties": {
"dynamic": {
"type": "boolean"
},
"includes": {
"type": "array"
},
"excludes": {
"type": "array"
}
},
"required": [
"dynamic",
"includes",
"excludes"
]
},
{
"type": "array",
"enum": [
[],
[]
]
}
],
"type": "null"
}
},
"required": [
"type",
"details"
]
}
},
"storage_field": {
"type": "string"
},
"excluded_block_ids": {
"type": "array"
}
},
"required": [
"title",
"description",
"is_active",
"should_be_signed",
"is_processing",
"template_id",
"target_population",
"storage_field"
],
"additionalProperties": false
}
}
}400Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 400
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}401Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 401
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}403Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 403
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}404Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 404
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}406Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 406
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}422Headers
Content-Type: application/jsonBody
{
"message": "Descriptive error message",
"status_code": 422,
"errors": [
"Error message"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
},
"errors": {
"type": "array"
}
}
}500Headers
Content-Type: application/jsonBody
{
"message": "Internal Error",
"status_code": 500
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}Toggle activePATCH/document-generators/{id}/toggle-active
Toggle active of the Document Generator
Example URI
- id
number(required) Example: 123Id of the Document Generator.
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>202Headers
Content-Type: application/jsonBody
{
"data": {
"title": "document generator name",
"description": "document generator description",
"is_active": true,
"should_be_signed": false,
"is_processing": false,
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
},
"template_id": 1,
"target_population": [
{
"type": "all",
"details": {
"dynamic": true,
"includes": [
"group_a"
],
"excludes": [
"group_b",
"group_c"
]
}
}
],
"storage_field": "alias of field",
"excluded_block_ids": [
"block001",
"block002"
]
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"title": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"should_be_signed": {
"type": "boolean"
},
"is_processing": {
"type": "boolean"
},
"pso_type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"system_required": {
"type": "boolean"
},
"creation_form_instance_id": {
"type": "number"
},
"profile_form_instance_id": {
"type": "number"
}
},
"required": [
"id",
"name",
"alias",
"description",
"is_active",
"system_required",
"creation_form_instance_id",
"profile_form_instance_id"
],
"additionalProperties": false
},
"template_id": {
"type": "number"
},
"target_population": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"all",
"group",
"pso",
"relation"
]
},
"details": {
"anyOf": [
{
"type": "object",
"properties": {
"dynamic": {
"type": "boolean"
},
"includes": {
"type": "array"
},
"excludes": {
"type": "array"
}
},
"required": [
"dynamic",
"includes",
"excludes"
]
},
{
"type": "array",
"enum": [
[],
[]
]
}
],
"type": "null"
}
},
"required": [
"type",
"details"
]
}
},
"storage_field": {
"type": "string"
},
"excluded_block_ids": {
"type": "array"
}
},
"required": [
"title",
"description",
"is_active",
"should_be_signed",
"is_processing",
"template_id",
"target_population",
"storage_field"
],
"additionalProperties": false
}
}
}400Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 400
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}401Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 401
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}403Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 403
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}404Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 404
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}406Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 406
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}422Headers
Content-Type: application/jsonBody
{
"message": "Descriptive error message",
"status_code": 422,
"errors": [
"Error message"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
},
"errors": {
"type": "array"
}
}
}500Headers
Content-Type: application/jsonBody
{
"message": "Internal Error",
"status_code": 500
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}Document Templates ¶
Document Templates used by document generators. It may include simple text or data from fields (field aliases wraped by bracers, ex: {usr_first_name})
Document Templates ¶
Common ListGET/document-templates{?title,pso-type,active,sort-by,sort-direction,page,per-page,no-pagination}
Get list of document templates matches specified filters
Example URI
- title
string(optional) Example: Document template name to searchSearch by title. Non strict, case-insensitive.
- pso-type
string(optional) Example: usrPso Type trigram to filter document templates
- active
boolean(optional) Example: trueField for filter exports by
is_activecolumn- sort-by
name, created_at(required) Example: name- sort-direction
asc, desc(required) Example: asc- page
number(required) Example: 1Page number.
1by default- per-page
number(required) Example: 10Number of items per page,
25by default- no-pagination
boolean(required) Example: falseif presented and positive pagination will not be applied. All available items will be returned.
Note: it may have significant impact on the performance
Note: once this option positive and presented -
metaattribute with pagination data will be omit in response
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>200Headers
Content-Type: application/jsonBody
{
"data": [
{
"title": "document template name",
"description": "document template description",
"is_active": true,
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
},
"blocks": [
{
"id": "block001",
"content": "Some stuff with <b>html</b>",
"conditions": [
{
"field": "employment_contract_type",
"comparison": "=",
"value": "internship"
}
]
}
]
}
],
"meta": {
"pagination": {
"total": 238,
"count": 25,
"per_page": 25,
"current_page": 2,
"total_pages": 10,
"links": {
"previous": "http://example.com/api/<endpoint>?page=1",
"next": "http://example.com/api/<endpoint>?page=3"
}
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"title": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"pso_type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"system_required": {
"type": "boolean"
},
"creation_form_instance_id": {
"type": "number"
},
"profile_form_instance_id": {
"type": "number"
}
},
"required": [
"id",
"name",
"alias",
"description",
"is_active",
"system_required",
"creation_form_instance_id",
"profile_form_instance_id"
],
"additionalProperties": false
},
"blocks": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"enum": [
"block001"
]
},
"content": {
"type": "string",
"enum": [
"Some stuff with <b>html</b>"
]
},
"conditions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"field": {
"type": "string",
"enum": [
"employment_contract_type"
]
},
"comparison": {
"type": "string",
"enum": [
"="
]
},
"value": {
"type": "string",
"enum": [
"internship"
]
}
},
"required": [
"field",
"comparison",
"value"
],
"additionalProperties": false
}
}
},
"required": [
"id",
"content",
"conditions"
],
"additionalProperties": false
}
}
},
"required": [
"title",
"description",
"is_active",
"pso_type",
"blocks"
]
}
},
"meta": {
"type": "object",
"properties": {
"pagination": {
"type": "object",
"properties": {
"total": {
"type": "number"
},
"count": {
"type": "number"
},
"per_page": {
"type": "number"
},
"current_page": {
"type": "number"
},
"total_pages": {
"type": "number"
},
"links": {
"type": "object",
"properties": {
"previous": {
"type": "string"
},
"next": {
"type": "string"
}
},
"required": [
"previous",
"next"
]
}
},
"required": [
"total",
"count",
"per_page",
"current_page",
"total_pages",
"links"
],
"additionalProperties": false
}
},
"required": [
"pagination"
]
}
}
}401Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 401
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}403Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 403
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}404Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 404
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}406Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 406
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}422Headers
Content-Type: application/jsonBody
{
"message": "Descriptive error message",
"status_code": 422,
"errors": [
"Error message"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
},
"errors": {
"type": "array"
}
}
}500Headers
Content-Type: application/jsonBody
{
"message": "Internal Error",
"status_code": 500
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}ShowGET/document-templates/{id}
Fetch single document template
Example URI
- id
number(required) Example: queryId of the Document Template.
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: '*'200Headers
Content-Type: application/jsonBody
{
"data": {
"title": "document template name",
"description": "document template description",
"is_active": true,
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
},
"blocks": [
{
"id": "block001",
"content": "Some stuff with <b>html</b>",
"conditions": [
{
"field": "employment_contract_type",
"comparison": "=",
"value": "internship"
}
]
}
]
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"title": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"pso_type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"system_required": {
"type": "boolean"
},
"creation_form_instance_id": {
"type": "number"
},
"profile_form_instance_id": {
"type": "number"
}
},
"required": [
"id",
"name",
"alias",
"description",
"is_active",
"system_required",
"creation_form_instance_id",
"profile_form_instance_id"
],
"additionalProperties": false
},
"blocks": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"enum": [
"block001"
]
},
"content": {
"type": "string",
"enum": [
"Some stuff with <b>html</b>"
]
},
"conditions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"field": {
"type": "string",
"enum": [
"employment_contract_type"
]
},
"comparison": {
"type": "string",
"enum": [
"="
]
},
"value": {
"type": "string",
"enum": [
"internship"
]
}
},
"required": [
"field",
"comparison",
"value"
],
"additionalProperties": false
}
}
},
"required": [
"id",
"content",
"conditions"
],
"additionalProperties": false
}
}
},
"required": [
"title",
"description",
"is_active",
"pso_type",
"blocks"
],
"additionalProperties": false
}
}
}401Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 401
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}403Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 403
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}404Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 404
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}406Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 406
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}422Headers
Content-Type: application/jsonBody
{
"message": "Descriptive error message",
"status_code": 422,
"errors": [
"Error message"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
},
"errors": {
"type": "array"
}
}
}500Headers
Content-Type: application/jsonBody
{
"message": "Internal Error",
"status_code": 500
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}CreatePOST/document-templates
Create Document Template
Example URI
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: '*'Body
{
"title": {
"en": "Some text",
"fr": "Du texte",
"de": "Setwas Text",
"es": "Algún texto"
},
"description": {
"en": "Some text",
"fr": "Du texte",
"de": "Setwas Text",
"es": "Algún texto"
},
"is_active": true,
"blocks": [
{
"id": "block001",
"content": "Some stuff with <b>html</b>",
"conditions": [
{
"field": "employment_contract_type",
"comparison": "=",
"value": "internship"
}
]
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"title": {
"type": "object",
"properties": {
"en": {
"type": "string"
},
"fr": {
"type": "string"
},
"de": {
"type": "string"
},
"es": {
"type": "string"
}
},
"required": [
"en",
"fr",
"de",
"es"
]
},
"description": {
"type": "object",
"properties": {
"en": {
"type": "string"
},
"fr": {
"type": "string"
},
"de": {
"type": "string"
},
"es": {
"type": "string"
}
},
"required": [
"en",
"fr",
"de",
"es"
]
},
"is_active": {
"type": "boolean"
},
"blocks": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"enum": [
"block001"
]
},
"content": {
"type": "string",
"enum": [
"Some stuff with <b>html</b>"
]
},
"conditions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"field": {
"type": "string",
"enum": [
"employment_contract_type"
]
},
"comparison": {
"type": "string",
"enum": [
"="
]
},
"value": {
"type": "string",
"enum": [
"internship"
]
}
},
"required": [
"field",
"comparison",
"value"
],
"additionalProperties": false
}
}
},
"required": [
"id",
"content",
"conditions"
],
"additionalProperties": false
}
}
},
"required": [
"title",
"description",
"is_active",
"blocks"
]
}201Headers
Content-Type: application/jsonBody
{
"data": {
"title": "document template name",
"description": "document template description",
"is_active": true,
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
},
"blocks": [
{
"id": "block001",
"content": "Some stuff with <b>html</b>",
"conditions": [
{
"field": "employment_contract_type",
"comparison": "=",
"value": "internship"
}
]
}
]
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"title": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"pso_type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"system_required": {
"type": "boolean"
},
"creation_form_instance_id": {
"type": "number"
},
"profile_form_instance_id": {
"type": "number"
}
},
"required": [
"id",
"name",
"alias",
"description",
"is_active",
"system_required",
"creation_form_instance_id",
"profile_form_instance_id"
],
"additionalProperties": false
},
"blocks": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"enum": [
"block001"
]
},
"content": {
"type": "string",
"enum": [
"Some stuff with <b>html</b>"
]
},
"conditions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"field": {
"type": "string",
"enum": [
"employment_contract_type"
]
},
"comparison": {
"type": "string",
"enum": [
"="
]
},
"value": {
"type": "string",
"enum": [
"internship"
]
}
},
"required": [
"field",
"comparison",
"value"
],
"additionalProperties": false
}
}
},
"required": [
"id",
"content",
"conditions"
],
"additionalProperties": false
}
}
},
"required": [
"title",
"description",
"is_active",
"pso_type",
"blocks"
],
"additionalProperties": false
}
}
}400Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 400
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}401Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 401
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}403Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 403
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}404Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 404
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}406Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 406
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}422Headers
Content-Type: application/jsonBody
{
"message": "Descriptive error message",
"status_code": 422,
"errors": [
"Error message"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
},
"errors": {
"type": "array"
}
}
}500Headers
Content-Type: application/jsonBody
{
"message": "Internal Error",
"status_code": 500
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}UpdatePATCH/document-templates/{id}
Update Document Generator
Example URI
- id
number(required) Example: 123Id of the Document Generator.
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>Body
{
"title": {
"en": "Some text",
"fr": "Du texte",
"de": "Setwas Text",
"es": "Algún texto"
},
"description": {
"en": "Some text",
"fr": "Du texte",
"de": "Setwas Text",
"es": "Algún texto"
},
"is_active": true,
"blocks": [
{
"id": "block001",
"content": "Some stuff with <b>html</b>",
"conditions": [
{
"field": "employment_contract_type",
"comparison": "=",
"value": "internship"
}
]
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"title": {
"type": "object",
"properties": {
"en": {
"type": "string"
},
"fr": {
"type": "string"
},
"de": {
"type": "string"
},
"es": {
"type": "string"
}
},
"required": [
"en",
"fr",
"de",
"es"
]
},
"description": {
"type": "object",
"properties": {
"en": {
"type": "string"
},
"fr": {
"type": "string"
},
"de": {
"type": "string"
},
"es": {
"type": "string"
}
},
"required": [
"en",
"fr",
"de",
"es"
]
},
"is_active": {
"type": "boolean"
},
"blocks": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"enum": [
"block001"
]
},
"content": {
"type": "string",
"enum": [
"Some stuff with <b>html</b>"
]
},
"conditions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"field": {
"type": "string",
"enum": [
"employment_contract_type"
]
},
"comparison": {
"type": "string",
"enum": [
"="
]
},
"value": {
"type": "string",
"enum": [
"internship"
]
}
},
"required": [
"field",
"comparison",
"value"
],
"additionalProperties": false
}
}
},
"required": [
"id",
"content",
"conditions"
],
"additionalProperties": false
}
}
},
"required": [
"title",
"description",
"is_active",
"blocks"
]
}202Headers
Content-Type: application/jsonBody
{
"data": {
"title": "document template name",
"description": "document template description",
"is_active": true,
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
},
"blocks": [
{
"id": "block001",
"content": "Some stuff with <b>html</b>",
"conditions": [
{
"field": "employment_contract_type",
"comparison": "=",
"value": "internship"
}
]
}
]
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"title": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"pso_type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"system_required": {
"type": "boolean"
},
"creation_form_instance_id": {
"type": "number"
},
"profile_form_instance_id": {
"type": "number"
}
},
"required": [
"id",
"name",
"alias",
"description",
"is_active",
"system_required",
"creation_form_instance_id",
"profile_form_instance_id"
],
"additionalProperties": false
},
"blocks": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"enum": [
"block001"
]
},
"content": {
"type": "string",
"enum": [
"Some stuff with <b>html</b>"
]
},
"conditions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"field": {
"type": "string",
"enum": [
"employment_contract_type"
]
},
"comparison": {
"type": "string",
"enum": [
"="
]
},
"value": {
"type": "string",
"enum": [
"internship"
]
}
},
"required": [
"field",
"comparison",
"value"
],
"additionalProperties": false
}
}
},
"required": [
"id",
"content",
"conditions"
],
"additionalProperties": false
}
}
},
"required": [
"title",
"description",
"is_active",
"pso_type",
"blocks"
],
"additionalProperties": false
}
}
}400Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 400
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}401Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 401
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}403Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 403
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}404Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 404
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}406Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 406
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}422Headers
Content-Type: application/jsonBody
{
"message": "Descriptive error message",
"status_code": 422,
"errors": [
"Error message"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
},
"errors": {
"type": "array"
}
}
}500Headers
Content-Type: application/jsonBody
{
"message": "Internal Error",
"status_code": 500
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}DeleteDELETE/document-templates/{id}
Delete Document Template
Example URI
- id
number(required) Example: 123Id of the Document Template
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: '*'204Headers
Content-Type: application/json401Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 401
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}403Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 403
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}404Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 404
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}406Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 406
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}422Headers
Content-Type: application/jsonBody
{
"message": "Descriptive error message",
"status_code": 422,
"errors": [
"Error message"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
},
"errors": {
"type": "array"
}
}
}500Headers
Content-Type: application/jsonBody
{
"message": "Internal Error",
"status_code": 500
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}CopyPOST/document-templates/{id}/copy
Copy Document Template
Example URI
- id
number(required) Example: 123Id of the Document Template.
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>Body
{
"title": {
"en": "Some text",
"fr": "Du texte",
"de": "Setwas Text",
"es": "Algún texto"
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"title": {
"type": "object",
"properties": {
"en": {
"type": "string"
},
"fr": {
"type": "string"
},
"de": {
"type": "string"
},
"es": {
"type": "string"
}
},
"required": [
"en",
"fr",
"de",
"es"
]
}
}
}202Headers
Content-Type: application/jsonBody
{
"data": {
"title": "document template name",
"description": "document template description",
"is_active": true,
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
},
"blocks": [
{
"id": "block001",
"content": "Some stuff with <b>html</b>",
"conditions": [
{
"field": "employment_contract_type",
"comparison": "=",
"value": "internship"
}
]
}
]
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"title": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"pso_type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"system_required": {
"type": "boolean"
},
"creation_form_instance_id": {
"type": "number"
},
"profile_form_instance_id": {
"type": "number"
}
},
"required": [
"id",
"name",
"alias",
"description",
"is_active",
"system_required",
"creation_form_instance_id",
"profile_form_instance_id"
],
"additionalProperties": false
},
"blocks": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"enum": [
"block001"
]
},
"content": {
"type": "string",
"enum": [
"Some stuff with <b>html</b>"
]
},
"conditions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"field": {
"type": "string",
"enum": [
"employment_contract_type"
]
},
"comparison": {
"type": "string",
"enum": [
"="
]
},
"value": {
"type": "string",
"enum": [
"internship"
]
}
},
"required": [
"field",
"comparison",
"value"
],
"additionalProperties": false
}
}
},
"required": [
"id",
"content",
"conditions"
],
"additionalProperties": false
}
}
},
"required": [
"title",
"description",
"is_active",
"pso_type",
"blocks"
],
"additionalProperties": false
}
}
}400Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 400
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}401Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 401
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}403Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 403
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}404Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 404
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}406Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 406
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}422Headers
Content-Type: application/jsonBody
{
"message": "Descriptive error message",
"status_code": 422,
"errors": [
"Error message"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
},
"errors": {
"type": "array"
}
}
}500Headers
Content-Type: application/jsonBody
{
"message": "Internal Error",
"status_code": 500
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}Toggle activePATCH/document-templates/{id}/toggle-active
Toggle active of the Document Template
Example URI
- id
number(required) Example: 123Id of the Document Templates.
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>202Headers
Content-Type: application/jsonBody
{
"data": {
"title": "document template name",
"description": "document template description",
"is_active": true,
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
},
"blocks": [
{
"id": "block001",
"content": "Some stuff with <b>html</b>",
"conditions": [
{
"field": "employment_contract_type",
"comparison": "=",
"value": "internship"
}
]
}
]
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"title": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"pso_type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"system_required": {
"type": "boolean"
},
"creation_form_instance_id": {
"type": "number"
},
"profile_form_instance_id": {
"type": "number"
}
},
"required": [
"id",
"name",
"alias",
"description",
"is_active",
"system_required",
"creation_form_instance_id",
"profile_form_instance_id"
],
"additionalProperties": false
},
"blocks": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"enum": [
"block001"
]
},
"content": {
"type": "string",
"enum": [
"Some stuff with <b>html</b>"
]
},
"conditions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"field": {
"type": "string",
"enum": [
"employment_contract_type"
]
},
"comparison": {
"type": "string",
"enum": [
"="
]
},
"value": {
"type": "string",
"enum": [
"internship"
]
}
},
"required": [
"field",
"comparison",
"value"
],
"additionalProperties": false
}
}
},
"required": [
"id",
"content",
"conditions"
],
"additionalProperties": false
}
}
},
"required": [
"title",
"description",
"is_active",
"pso_type",
"blocks"
],
"additionalProperties": false
}
}
}400Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 400
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}401Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 401
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}403Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 403
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}404Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 404
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}406Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 406
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}422Headers
Content-Type: application/jsonBody
{
"message": "Descriptive error message",
"status_code": 422,
"errors": [
"Error message"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
},
"errors": {
"type": "array"
}
}
}500Headers
Content-Type: application/jsonBody
{
"message": "Internal Error",
"status_code": 500
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}Domains ¶
Fields domains.
Domains ¶
ListGET/domains{?pso-type,active,search,sort-by,sort-direction}
Fetch list of domains
Example URI
- pso-type
number(optional) Example: 123PSO type ID to filtering.
- active
boolean(optional) Example: trueTo filtering domains by active state
- search
string(optional) Example: Domains to searchSearch by domain title. Non strict, case-insensitive.
- sort-by
name, pso-type(optional) Default: name Example: nameField to sort domains by.
- sort-direction
asc, desc(optional) Default: asc Example: ascDirection to order domains by.
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>200Headers
Content-Type: application/jsonBody
{
"data": [
{
"id": 46,
"alias": "usr_global",
"name": "User Global",
"description": "...",
"is_editable": false,
"is_removable": false,
"is_active": true,
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
}
}
],
"meta": {
"pagination": {
"total": 238,
"count": 25,
"per_page": 25,
"current_page": 2,
"total_pages": 10,
"links": {
"previous": "http://example.com/api/<endpoint>?page=1",
"next": "http://example.com/api/<endpoint>?page=3"
}
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"alias": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"is_editable": {
"type": "boolean"
},
"is_removable": {
"type": "boolean"
},
"is_active": {
"type": "boolean"
},
"pso_type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"system_required": {
"type": "boolean"
},
"creation_form_instance_id": {
"type": "number"
},
"profile_form_instance_id": {
"type": "number"
}
},
"required": [
"id",
"name",
"alias",
"description",
"is_active",
"system_required",
"creation_form_instance_id",
"profile_form_instance_id"
],
"additionalProperties": false
}
},
"required": [
"id",
"alias",
"name",
"description",
"is_editable",
"is_removable",
"is_active"
]
}
},
"meta": {
"type": "object",
"properties": {
"pagination": {
"type": "object",
"properties": {
"total": {
"type": "number"
},
"count": {
"type": "number"
},
"per_page": {
"type": "number"
},
"current_page": {
"type": "number"
},
"total_pages": {
"type": "number"
},
"links": {
"type": "object",
"properties": {
"previous": {
"type": "string"
},
"next": {
"type": "string"
}
},
"required": [
"previous",
"next"
]
}
},
"required": [
"total",
"count",
"per_page",
"current_page",
"total_pages",
"links"
],
"additionalProperties": false
}
},
"required": [
"pagination"
]
}
}
}401Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 401
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}403Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 403
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}404Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 404
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}406Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 406
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}422Headers
Content-Type: application/jsonBody
{
"message": "Descriptive error message",
"status_code": 422,
"errors": [
"Error message"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
},
"errors": {
"type": "array"
}
}
}500Headers
Content-Type: application/jsonBody
{
"message": "Internal Error",
"status_code": 500
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}CreatePOST/domains
Create new domain item
Example URI
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>Body
{
"pso_type": "usr",
"name": {
"en": "Some text",
"fr": "Du texte",
"de": "Setwas Text",
"es": "Algún texto"
},
"description": {
"en": "Some text",
"fr": "Du texte",
"de": "Setwas Text",
"es": "Algún texto"
},
"alias": "usr_global",
"is_editable": false,
"is_removable": false,
"is_active": true
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"pso_type": {
"type": "string"
},
"name": {
"type": "object",
"properties": {
"en": {
"type": "string"
},
"fr": {
"type": "string"
},
"de": {
"type": "string"
},
"es": {
"type": "string"
}
},
"required": [
"en",
"fr",
"de",
"es"
]
},
"description": {
"type": "object",
"properties": {
"en": {
"type": "string"
},
"fr": {
"type": "string"
},
"de": {
"type": "string"
},
"es": {
"type": "string"
}
},
"required": [
"en",
"fr",
"de",
"es"
]
},
"alias": {
"type": "string"
},
"is_editable": {
"type": "boolean"
},
"is_removable": {
"type": "boolean"
},
"is_active": {
"type": "boolean"
}
},
"required": [
"pso_type",
"name"
]
}201Headers
Content-Type: application/jsonBody
{
"data": {
"id": 46,
"alias": "usr_global",
"name": "User Global",
"description": "...",
"is_editable": false,
"is_removable": false,
"is_active": true,
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"alias": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"is_editable": {
"type": "boolean"
},
"is_removable": {
"type": "boolean"
},
"is_active": {
"type": "boolean"
},
"pso_type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"system_required": {
"type": "boolean"
},
"creation_form_instance_id": {
"type": "number"
},
"profile_form_instance_id": {
"type": "number"
}
},
"required": [
"id",
"name",
"alias",
"description",
"is_active",
"system_required",
"creation_form_instance_id",
"profile_form_instance_id"
],
"additionalProperties": false
}
},
"required": [
"id",
"alias",
"name",
"description",
"is_editable",
"is_removable",
"is_active"
],
"additionalProperties": false
}
}
}400Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 400
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}401Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 401
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}403Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 403
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}404Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 404
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}406Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 406
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}422Headers
Content-Type: application/jsonBody
{
"message": "Descriptive error message",
"status_code": 422,
"errors": [
"Error message"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
},
"errors": {
"type": "array"
}
}
}500Headers
Content-Type: application/jsonBody
{
"message": "Internal Error",
"status_code": 500
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}ShowGET/domains/{alias}
Fetch single domain item
Example URI
- alias
string(required) Example: somedomainAlias of the Domain item.
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>200Headers
Content-Type: application/jsonBody
{
"data": {
"id": 46,
"alias": "usr_global",
"name": "User Global",
"description": "...",
"is_editable": false,
"is_removable": false,
"is_active": true,
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"alias": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"is_editable": {
"type": "boolean"
},
"is_removable": {
"type": "boolean"
},
"is_active": {
"type": "boolean"
},
"pso_type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"system_required": {
"type": "boolean"
},
"creation_form_instance_id": {
"type": "number"
},
"profile_form_instance_id": {
"type": "number"
}
},
"required": [
"id",
"name",
"alias",
"description",
"is_active",
"system_required",
"creation_form_instance_id",
"profile_form_instance_id"
],
"additionalProperties": false
}
},
"required": [
"id",
"alias",
"name",
"description",
"is_editable",
"is_removable",
"is_active"
],
"additionalProperties": false
}
}
}401Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 401
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}403Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 403
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}404Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 404
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}406Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 406
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}422Headers
Content-Type: application/jsonBody
{
"message": "Descriptive error message",
"status_code": 422,
"errors": [
"Error message"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
},
"errors": {
"type": "array"
}
}
}500Headers
Content-Type: application/jsonBody
{
"message": "Internal Error",
"status_code": 500
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}DeleteDELETE/domains/{alias}
Delete domain item
Example URI
- alias
string(required) Example: somedomainAlias of the Domain item.
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>204Headers
Content-Type: application/json401Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 401
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}403Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 403
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}404Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 404
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}406Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 406
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}422Headers
Content-Type: application/jsonBody
{
"message": "Descriptive error message",
"status_code": 422,
"errors": [
"Error message"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
},
"errors": {
"type": "array"
}
}
}500Headers
Content-Type: application/jsonBody
{
"message": "Internal Error",
"status_code": 500
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}UpdatePATCH/domains/{alias}
Update domain item
Example URI
- alias
string(required) Example: somedomainAlias of the Domain item.
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>Body
{
"name": {
"en": "Some text",
"fr": "Du texte",
"de": "Setwas Text",
"es": "Algún texto"
},
"description": {
"en": "Some text",
"fr": "Du texte",
"de": "Setwas Text",
"es": "Algún texto"
},
"is_editable": false,
"is_removable": false,
"is_active": true
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"name": {
"type": "object",
"properties": {
"en": {
"type": "string"
},
"fr": {
"type": "string"
},
"de": {
"type": "string"
},
"es": {
"type": "string"
}
},
"required": [
"en",
"fr",
"de",
"es"
]
},
"description": {
"type": "object",
"properties": {
"en": {
"type": "string"
},
"fr": {
"type": "string"
},
"de": {
"type": "string"
},
"es": {
"type": "string"
}
},
"required": [
"en",
"fr",
"de",
"es"
]
},
"is_editable": {
"type": "boolean"
},
"is_removable": {
"type": "boolean"
},
"is_active": {
"type": "boolean"
}
}
}202Headers
Content-Type: application/jsonBody
{
"data": {
"id": 46,
"alias": "usr_global",
"name": "User Global",
"description": "...",
"is_editable": false,
"is_removable": false,
"is_active": true,
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"alias": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"is_editable": {
"type": "boolean"
},
"is_removable": {
"type": "boolean"
},
"is_active": {
"type": "boolean"
},
"pso_type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"system_required": {
"type": "boolean"
},
"creation_form_instance_id": {
"type": "number"
},
"profile_form_instance_id": {
"type": "number"
}
},
"required": [
"id",
"name",
"alias",
"description",
"is_active",
"system_required",
"creation_form_instance_id",
"profile_form_instance_id"
],
"additionalProperties": false
}
},
"required": [
"id",
"alias",
"name",
"description",
"is_editable",
"is_removable",
"is_active"
],
"additionalProperties": false
}
}
}400Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 400
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}401Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 401
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}403Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 403
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}404Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 404
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}406Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 406
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}422Headers
Content-Type: application/jsonBody
{
"message": "Descriptive error message",
"status_code": 422,
"errors": [
"Error message"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
},
"errors": {
"type": "array"
}
}
}500Headers
Content-Type: application/jsonBody
{
"message": "Internal Error",
"status_code": 500
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}Fields ¶
Fields instances data.
Fields ¶
ListGET/fields{?name,active,category,privacy-level,pso-type,data-type,append_profile,target-pso-type,allow-inactive-options,allow-items,sort-by,sort-direction}
Fetch list of fields
Example URI
- name
string(optional) Example: Field to searchSearch by fields title. Non strict, case-insensitive.
- active
boolean(optional) Example: trueTo filtering fields by active state.
- category
string(optional) Example: usr_categoryGet only fields related to selected category. Fields category aliases used.
- privacy-level
public, encrypted, extreme(optional) Example: publicTo filtering fields by privacy level.
- pso-type
number(optional) Example: 123PSO type alias to filtering.
- data-type
array[string](optional) Example: stringArray of data types aliases to filtering.
- append_profile
boolean(optional) Example: trueGet only fields, appended to pso profile forms.
- target-pso-type
string(optional) Example: usrGet only related fields which link to selected pso type(alias should be provided).
- allow-inactive-options
boolean(optional) Example: trueReturn only active option items(for datatypes which supports options).
- allow-items
boolean(optional) Example: trueReturn composite field items, not only roots.
- sort-by
name, pso-type(optional) Default: name Example: nameColumn to sort fields by.
- sort-direction
asc, desc(optional) Default: asc Example: ascDirection to order fields categories by.
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>200Headers
Content-Type: application/jsonBody
{
"data": [
{
"id": 1,
"name": "Field Name",
"position": 5,
"alias": "usr_first_name",
"has_unique_data": false,
"has_value": true,
"removable": false,
"is_active": true,
"list": false,
"read_only": false,
"required": true,
"type": {
"id": 1,
"name": "Data Type Name",
"alias": "data_type_alias",
"settings": [
{
"id": 1,
"name": "Data Type Setting Name",
"alias": "data_type_setting_alias",
"is_required": true
}
],
"supports_collection": false,
"supports_read_only": false,
"supports_unique": false
},
"category": {
"id": 32,
"alias": "usr_identity",
"position": 5,
"system_required": true,
"name": "Identity",
"description": "...",
"is_active": true,
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
}
},
"domains": [
{
"id": 46,
"alias": "usr_global",
"name": "User Global",
"description": "...",
"is_editable": false,
"is_removable": false,
"is_active": true,
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
}
}
],
"privacy_level": {
"id": 123,
"alias": "public",
"name": "Not Sensitive",
"level": 100
},
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
},
"items": [
{}
],
"options": [
{
"id": 198,
"name": "Chose me!",
"position": 9,
"value": "198",
"is_active": true
}
],
"settings": []
}
],
"meta": {
"pagination": {
"total": 238,
"count": 25,
"per_page": 25,
"current_page": 2,
"total_pages": 10,
"links": {
"previous": "http://example.com/api/<endpoint>?page=1",
"next": "http://example.com/api/<endpoint>?page=3"
}
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"position": {
"type": "number"
},
"alias": {
"type": "string"
},
"has_unique_data": {
"type": "boolean",
"description": "whether field requires values to be unique across system"
},
"has_value": {
"type": "boolean",
"description": "whether field has at least one value submitted"
},
"removable": {
"type": "boolean",
"description": "whether field can be removed from system"
},
"is_active": {
"type": "boolean"
},
"list": {
"type": "boolean",
"description": "whether field can handle collection of values"
},
"read_only": {
"type": "boolean",
"description": "whether field value can be changed"
},
"required": {
"type": "boolean",
"description": "whether field value required by system"
},
"type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"settings": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"is_required": {
"type": "boolean"
}
},
"required": [
"id",
"name",
"alias",
"is_required"
]
}
},
"supports_collection": {
"type": "boolean"
},
"supports_read_only": {
"type": "boolean"
},
"supports_unique": {
"type": "boolean"
}
},
"required": [
"id",
"name",
"alias",
"settings",
"supports_collection",
"supports_read_only",
"supports_unique"
],
"additionalProperties": false
},
"category": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"alias": {
"type": "string"
},
"position": {
"type": "number"
},
"system_required": {
"type": "boolean"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"pso_type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"system_required": {
"type": "boolean"
},
"creation_form_instance_id": {
"type": "number"
},
"profile_form_instance_id": {
"type": "number"
}
},
"required": [
"id",
"name",
"alias",
"description",
"is_active",
"system_required",
"creation_form_instance_id",
"profile_form_instance_id"
],
"additionalProperties": false
}
},
"required": [
"id",
"alias",
"position",
"system_required",
"name",
"description",
"is_active"
],
"additionalProperties": false
},
"domains": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"alias": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"is_editable": {
"type": "boolean"
},
"is_removable": {
"type": "boolean"
},
"is_active": {
"type": "boolean"
},
"pso_type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"system_required": {
"type": "boolean"
},
"creation_form_instance_id": {
"type": "number"
},
"profile_form_instance_id": {
"type": "number"
}
},
"required": [
"id",
"name",
"alias",
"description",
"is_active",
"system_required",
"creation_form_instance_id",
"profile_form_instance_id"
],
"additionalProperties": false
}
},
"required": [
"id",
"alias",
"name",
"description",
"is_editable",
"is_removable",
"is_active"
]
}
},
"privacy_level": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"alias": {
"type": "string"
},
"name": {
"type": "string"
},
"level": {
"type": "number"
}
},
"required": [
"id",
"alias",
"name",
"level"
],
"additionalProperties": false
},
"pso_type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"system_required": {
"type": "boolean"
},
"creation_form_instance_id": {
"type": "number"
},
"profile_form_instance_id": {
"type": "number"
}
},
"required": [
"id",
"name",
"alias",
"description",
"is_active",
"system_required",
"creation_form_instance_id",
"profile_form_instance_id"
],
"additionalProperties": false
},
"items": {
"type": [
"array",
"null"
],
"items": {
"type": "object",
"properties": {}
}
},
"options": {
"type": [
"array",
"null"
],
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"position": {
"type": "number"
},
"value": {
"type": "string"
},
"is_active": {
"type": "boolean"
}
},
"required": [
"id",
"name",
"position",
"value",
"is_active"
]
},
"description": "List of options with possible (allowed) values."
},
"settings": {
"type": "array",
"items": {
"type": "string"
},
"description": "Common field settings"
}
},
"required": [
"id",
"name",
"position",
"alias",
"has_unique_data",
"has_value",
"removable",
"is_active",
"list",
"read_only",
"required"
]
}
},
"meta": {
"type": "object",
"properties": {
"pagination": {
"type": "object",
"properties": {
"total": {
"type": "number"
},
"count": {
"type": "number"
},
"per_page": {
"type": "number"
},
"current_page": {
"type": "number"
},
"total_pages": {
"type": "number"
},
"links": {
"type": "object",
"properties": {
"previous": {
"type": "string"
},
"next": {
"type": "string"
}
},
"required": [
"previous",
"next"
]
}
},
"required": [
"total",
"count",
"per_page",
"current_page",
"total_pages",
"links"
],
"additionalProperties": false
}
},
"required": [
"pagination"
]
}
}
}401Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 401
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}403Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 403
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}404Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 404
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}406Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 406
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}422Headers
Content-Type: application/jsonBody
{
"message": "Descriptive error message",
"status_code": 422,
"errors": [
"Error message"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
},
"errors": {
"type": "array"
}
}
}500Headers
Content-Type: application/jsonBody
{
"message": "Internal Error",
"status_code": 500
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}CreatePOST/fields
Create new field item
Example URI
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>Body
{
"name": {
"en": "Some text",
"fr": "Du texte",
"de": "Setwas Text",
"es": "Algún texto"
},
"type": "string",
"privacy_level": "public",
"category": "usr_first_name",
"is_active": true,
"list": true,
"read_only": false,
"pso_type": "usr",
"options": [
{
"name": {
"en": "Some text",
"fr": "Du texte",
"de": "Setwas Text",
"es": "Algún texto"
},
"position": 1,
"is_active": true
}
],
"items": [
{}
],
"settings": [
{
"setting_id": 123,
"value": "text"
}
],
"position": 5,
"alias": "usr_first_name",
"domains": [
"usr_global"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"name": {
"type": "object",
"properties": {
"en": {
"type": "string"
},
"fr": {
"type": "string"
},
"de": {
"type": "string"
},
"es": {
"type": "string"
}
},
"required": [
"en",
"fr",
"de",
"es"
]
},
"type": {
"type": "string"
},
"privacy_level": {
"type": "string",
"enum": [
"public",
"encrypted",
"extreme"
]
},
"category": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"list": {
"type": "boolean",
"description": "should it be \"list of\" field"
},
"read_only": {
"type": "boolean"
},
"pso_type": {
"type": "string"
},
"options": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "object",
"properties": {
"en": {
"type": "string"
},
"fr": {
"type": "string"
},
"de": {
"type": "string"
},
"es": {
"type": "string"
}
},
"required": [
"en",
"fr",
"de",
"es"
]
},
"position": {
"type": "number"
},
"is_active": {
"type": "boolean"
}
},
"required": [
"name",
"position",
"is_active"
]
}
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {}
}
},
"settings": {
"type": "array",
"items": {
"type": "object",
"properties": {
"setting_id": {
"type": "number"
},
"value": {
"type": "string"
}
},
"required": [
"setting_id",
"value"
]
}
},
"position": {
"type": "number"
},
"alias": {
"type": "string"
},
"domains": {
"type": "array",
"items": {
"type": "string"
},
"description": "array of domain aliases"
}
},
"required": [
"name",
"type",
"privacy_level",
"category",
"is_active",
"list",
"read_only",
"pso_type"
]
}201Headers
Content-Type: application/jsonBody
{
"data": {
"id": 32,
"alias": "usr_identity",
"position": 5,
"system_required": true,
"name": "Identity",
"description": "...",
"is_active": true,
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"alias": {
"type": "string"
},
"position": {
"type": "number"
},
"system_required": {
"type": "boolean"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"pso_type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"system_required": {
"type": "boolean"
},
"creation_form_instance_id": {
"type": "number"
},
"profile_form_instance_id": {
"type": "number"
}
},
"required": [
"id",
"name",
"alias",
"description",
"is_active",
"system_required",
"creation_form_instance_id",
"profile_form_instance_id"
],
"additionalProperties": false
}
},
"required": [
"id",
"alias",
"position",
"system_required",
"name",
"description",
"is_active"
],
"additionalProperties": false
}
}
}400Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 400
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}401Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 401
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}403Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 403
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}404Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 404
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}406Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 406
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}422Headers
Content-Type: application/jsonBody
{
"message": "Descriptive error message",
"status_code": 422,
"errors": [
"Error message"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
},
"errors": {
"type": "array"
}
}
}500Headers
Content-Type: application/jsonBody
{
"message": "Internal Error",
"status_code": 500
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}ShowGET/fields/{id}
Fetch single field item
Example URI
- id
string(required) Example: 123Alias of the Category item.
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>200Headers
Content-Type: application/jsonBody
{
"data": {
"id": 1,
"name": "Field Name",
"position": 5,
"alias": "usr_first_name",
"has_unique_data": false,
"has_value": true,
"removable": false,
"is_active": true,
"list": false,
"read_only": false,
"required": true,
"type": {
"id": 1,
"name": "Data Type Name",
"alias": "data_type_alias",
"settings": [
{
"id": 1,
"name": "Data Type Setting Name",
"alias": "data_type_setting_alias",
"is_required": true
}
],
"supports_collection": false,
"supports_read_only": false,
"supports_unique": false
},
"category": {
"id": 32,
"alias": "usr_identity",
"position": 5,
"system_required": true,
"name": "Identity",
"description": "...",
"is_active": true,
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
}
},
"domains": [
{
"id": 46,
"alias": "usr_global",
"name": "User Global",
"description": "...",
"is_editable": false,
"is_removable": false,
"is_active": true,
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
}
}
],
"privacy_level": {
"id": 123,
"alias": "public",
"name": "Not Sensitive",
"level": 100
},
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
},
"items": [
{}
],
"options": [
{
"id": 198,
"name": "Chose me!",
"position": 9,
"value": "198",
"is_active": true
}
],
"settings": []
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"position": {
"type": "number"
},
"alias": {
"type": "string"
},
"has_unique_data": {
"type": "boolean",
"description": "whether field requires values to be unique across system"
},
"has_value": {
"type": "boolean",
"description": "whether field has at least one value submitted"
},
"removable": {
"type": "boolean",
"description": "whether field can be removed from system"
},
"is_active": {
"type": "boolean"
},
"list": {
"type": "boolean",
"description": "whether field can handle collection of values"
},
"read_only": {
"type": "boolean",
"description": "whether field value can be changed"
},
"required": {
"type": "boolean",
"description": "whether field value required by system"
},
"type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"settings": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"is_required": {
"type": "boolean"
}
},
"required": [
"id",
"name",
"alias",
"is_required"
]
}
},
"supports_collection": {
"type": "boolean"
},
"supports_read_only": {
"type": "boolean"
},
"supports_unique": {
"type": "boolean"
}
},
"required": [
"id",
"name",
"alias",
"settings",
"supports_collection",
"supports_read_only",
"supports_unique"
],
"additionalProperties": false
},
"category": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"alias": {
"type": "string"
},
"position": {
"type": "number"
},
"system_required": {
"type": "boolean"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"pso_type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"system_required": {
"type": "boolean"
},
"creation_form_instance_id": {
"type": "number"
},
"profile_form_instance_id": {
"type": "number"
}
},
"required": [
"id",
"name",
"alias",
"description",
"is_active",
"system_required",
"creation_form_instance_id",
"profile_form_instance_id"
],
"additionalProperties": false
}
},
"required": [
"id",
"alias",
"position",
"system_required",
"name",
"description",
"is_active"
],
"additionalProperties": false
},
"domains": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"alias": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"is_editable": {
"type": "boolean"
},
"is_removable": {
"type": "boolean"
},
"is_active": {
"type": "boolean"
},
"pso_type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"system_required": {
"type": "boolean"
},
"creation_form_instance_id": {
"type": "number"
},
"profile_form_instance_id": {
"type": "number"
}
},
"required": [
"id",
"name",
"alias",
"description",
"is_active",
"system_required",
"creation_form_instance_id",
"profile_form_instance_id"
],
"additionalProperties": false
}
},
"required": [
"id",
"alias",
"name",
"description",
"is_editable",
"is_removable",
"is_active"
]
}
},
"privacy_level": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"alias": {
"type": "string"
},
"name": {
"type": "string"
},
"level": {
"type": "number"
}
},
"required": [
"id",
"alias",
"name",
"level"
],
"additionalProperties": false
},
"pso_type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"system_required": {
"type": "boolean"
},
"creation_form_instance_id": {
"type": "number"
},
"profile_form_instance_id": {
"type": "number"
}
},
"required": [
"id",
"name",
"alias",
"description",
"is_active",
"system_required",
"creation_form_instance_id",
"profile_form_instance_id"
],
"additionalProperties": false
},
"items": {
"type": [
"array",
"null"
],
"items": {
"type": "object",
"properties": {}
}
},
"options": {
"type": [
"array",
"null"
],
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"position": {
"type": "number"
},
"value": {
"type": "string"
},
"is_active": {
"type": "boolean"
}
},
"required": [
"id",
"name",
"position",
"value",
"is_active"
]
},
"description": "List of options with possible (allowed) values."
},
"settings": {
"type": "array",
"items": {
"type": "string"
},
"description": "Common field settings"
}
},
"required": [
"id",
"name",
"position",
"alias",
"has_unique_data",
"has_value",
"removable",
"is_active",
"list",
"read_only",
"required",
"items",
"options"
],
"additionalProperties": false
}
}
}401Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 401
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}403Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 403
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}404Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 404
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}406Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 406
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}422Headers
Content-Type: application/jsonBody
{
"message": "Descriptive error message",
"status_code": 422,
"errors": [
"Error message"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
},
"errors": {
"type": "array"
}
}
}500Headers
Content-Type: application/jsonBody
{
"message": "Internal Error",
"status_code": 500
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}DeleteDELETE/fields/{id}
Delete field item
Example URI
- id
string(required) Example: 123Alias of the Field item.
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>204Headers
Content-Type: application/json401Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 401
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}403Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 403
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}404Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 404
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}406Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 406
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}422Headers
Content-Type: application/jsonBody
{
"message": "Descriptive error message",
"status_code": 422,
"errors": [
"Error message"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
},
"errors": {
"type": "array"
}
}
}500Headers
Content-Type: application/jsonBody
{
"message": "Internal Error",
"status_code": 500
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}UpdatePATCH/category/{id}
Update field item
Example URI
- id
string(required) Example: 123Alias of the Category item.
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>Body
{
"id": 1,
"name": "Field Name",
"position": 5,
"alias": "usr_first_name",
"has_unique_data": false,
"has_value": true,
"removable": false,
"is_active": true,
"list": false,
"read_only": false,
"required": true,
"type": {
"id": 1,
"name": "Data Type Name",
"alias": "data_type_alias",
"settings": [
{
"id": 1,
"name": "Data Type Setting Name",
"alias": "data_type_setting_alias",
"is_required": true
}
],
"supports_collection": false,
"supports_read_only": false,
"supports_unique": false
},
"category": {
"id": 32,
"alias": "usr_identity",
"position": 5,
"system_required": true,
"name": "Identity",
"description": "...",
"is_active": true,
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
}
},
"domains": [
{
"id": 46,
"alias": "usr_global",
"name": "User Global",
"description": "...",
"is_editable": false,
"is_removable": false,
"is_active": true,
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
}
}
],
"privacy_level": {
"id": 123,
"alias": "public",
"name": "Not Sensitive",
"level": 100
},
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
},
"items": [
{}
],
"options": [
{
"id": 198,
"name": "Chose me!",
"position": 9,
"value": "198",
"is_active": true
}
],
"settings": []
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"position": {
"type": "number"
},
"alias": {
"type": "string"
},
"has_unique_data": {
"type": "boolean",
"description": "whether field requires values to be unique across system"
},
"has_value": {
"type": "boolean",
"description": "whether field has at least one value submitted"
},
"removable": {
"type": "boolean",
"description": "whether field can be removed from system"
},
"is_active": {
"type": "boolean"
},
"list": {
"type": "boolean",
"description": "whether field can handle collection of values"
},
"read_only": {
"type": "boolean",
"description": "whether field value can be changed"
},
"required": {
"type": "boolean",
"description": "whether field value required by system"
},
"type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"settings": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"is_required": {
"type": "boolean"
}
},
"required": [
"id",
"name",
"alias",
"is_required"
]
}
},
"supports_collection": {
"type": "boolean"
},
"supports_read_only": {
"type": "boolean"
},
"supports_unique": {
"type": "boolean"
}
},
"required": [
"id",
"name",
"alias",
"settings",
"supports_collection",
"supports_read_only",
"supports_unique"
],
"additionalProperties": false
},
"category": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"alias": {
"type": "string"
},
"position": {
"type": "number"
},
"system_required": {
"type": "boolean"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"pso_type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"system_required": {
"type": "boolean"
},
"creation_form_instance_id": {
"type": "number"
},
"profile_form_instance_id": {
"type": "number"
}
},
"required": [
"id",
"name",
"alias",
"description",
"is_active",
"system_required",
"creation_form_instance_id",
"profile_form_instance_id"
],
"additionalProperties": false
}
},
"required": [
"id",
"alias",
"position",
"system_required",
"name",
"description",
"is_active"
],
"additionalProperties": false
},
"domains": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"alias": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"is_editable": {
"type": "boolean"
},
"is_removable": {
"type": "boolean"
},
"is_active": {
"type": "boolean"
},
"pso_type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"system_required": {
"type": "boolean"
},
"creation_form_instance_id": {
"type": "number"
},
"profile_form_instance_id": {
"type": "number"
}
},
"required": [
"id",
"name",
"alias",
"description",
"is_active",
"system_required",
"creation_form_instance_id",
"profile_form_instance_id"
],
"additionalProperties": false
}
},
"required": [
"id",
"alias",
"name",
"description",
"is_editable",
"is_removable",
"is_active"
]
}
},
"privacy_level": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"alias": {
"type": "string"
},
"name": {
"type": "string"
},
"level": {
"type": "number"
}
},
"required": [
"id",
"alias",
"name",
"level"
],
"additionalProperties": false
},
"pso_type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"system_required": {
"type": "boolean"
},
"creation_form_instance_id": {
"type": "number"
},
"profile_form_instance_id": {
"type": "number"
}
},
"required": [
"id",
"name",
"alias",
"description",
"is_active",
"system_required",
"creation_form_instance_id",
"profile_form_instance_id"
],
"additionalProperties": false
},
"items": {
"type": [
"array",
"null"
],
"items": {
"type": "object",
"properties": {}
}
},
"options": {
"type": [
"array",
"null"
],
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"position": {
"type": "number"
},
"value": {
"type": "string"
},
"is_active": {
"type": "boolean"
}
},
"required": [
"id",
"name",
"position",
"value",
"is_active"
]
},
"description": "List of options with possible (allowed) values."
},
"settings": {
"type": "array",
"items": {
"type": "string"
},
"description": "Common field settings"
}
},
"required": [
"id",
"name",
"position",
"alias",
"has_unique_data",
"has_value",
"removable",
"is_active",
"list",
"read_only",
"required"
]
}202Headers
Content-Type: application/jsonBody
{
"data": {
"id": 32,
"alias": "usr_identity",
"position": 5,
"system_required": true,
"name": "Identity",
"description": "...",
"is_active": true,
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"alias": {
"type": "string"
},
"position": {
"type": "number"
},
"system_required": {
"type": "boolean"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"pso_type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"system_required": {
"type": "boolean"
},
"creation_form_instance_id": {
"type": "number"
},
"profile_form_instance_id": {
"type": "number"
}
},
"required": [
"id",
"name",
"alias",
"description",
"is_active",
"system_required",
"creation_form_instance_id",
"profile_form_instance_id"
],
"additionalProperties": false
}
},
"required": [
"id",
"alias",
"position",
"system_required",
"name",
"description",
"is_active"
],
"additionalProperties": false
}
}
}400Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 400
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}401Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 401
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}403Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 403
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}404Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 404
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}406Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 406
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}422Headers
Content-Type: application/jsonBody
{
"message": "Descriptive error message",
"status_code": 422,
"errors": [
"Error message"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
},
"errors": {
"type": "array"
}
}
}500Headers
Content-Type: application/jsonBody
{
"message": "Internal Error",
"status_code": 500
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}Fields Values ¶
Fields values of a user for selected form instance.
Fields Values ¶
CreatePOST/psos/{dataOwner}/form-instances/{formInstance}/fields/{field}/values
Add new answer value on field in form by user.
Example URI
- dataOwner
number(required) Example: 123Id of PSO who will own the value.
- formInstance
number(required) Example: 123Id of Form Instance.
- field
number(required) Example: 123Id of Field.
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>Body
{
"data": [
{
"field_id": 123,
"field_alias": "usr_first_name",
"value": "some value",
"answer_id": 123,
"batch": "d9438793-ce22-483d-8a80-9250b7f341fd",
"action": "create"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"field_id": {
"type": "number",
"description": "required without field_alias"
},
"field_alias": {
"type": "string",
"description": "required without field_id"
},
"value": {
"type": "string",
"description": "empty value will clear answer"
},
"answer_id": {
"type": "number",
"description": "needs if you try to update existed answer"
},
"batch": {
"type": "string",
"description": "needs if you works with composite list of fields"
},
"action": {
"type": "string",
"enum": [
"create",
"update",
"delete"
]
}
},
"required": [
"action"
]
}
}
}
}201Headers
Content-Type: application/json400Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 400
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}401Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 401
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}403Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 403
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}404Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 404
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}406Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 406
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}422Headers
Content-Type: application/jsonBody
{
"message": "Descriptive error message",
"status_code": 422,
"errors": [
"Error message"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
},
"errors": {
"type": "array"
}
}
}500Headers
Content-Type: application/jsonBody
{
"message": "Internal Error",
"status_code": 500
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}ShowGET/psos/{dataOwner}/form-instances/{formInstance}/fields/{field}/values
Get values answered by user(data owner) on field in form.
Example URI
- dataOwner
number(required) Example: 123Id of PSO who will own the value.
- formInstance
number(required) Example: 123Id of Form Instance.
- field
number(required) Example: 123Id of Field.
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>200Headers
Content-Type: application/jsonBody
{
"data": {
"id": 1,
"field": 123,
"values": [
"some value"
],
"created_at": "2019-01-24 12:23:00",
"updated_at": "2019-01-25 03:12:43",
"value_details": "some value",
"answers_count": 1,
"batch": "d9438793-ce22-483d-8a80-9250b7f341fd"
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"field": {
"type": "number"
},
"values": {
"type": "array"
},
"created_at": {
"type": "string"
},
"updated_at": {
"type": "string"
},
"value_details": {
"type": "string"
},
"answers_count": {
"type": "number",
"description": "useful for \"list of\" fields"
},
"batch": {
"type": "string"
}
},
"required": [
"id",
"field",
"values",
"created_at",
"updated_at",
"value_details",
"answers_count"
],
"additionalProperties": false
}
}
}401Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 401
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}403Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 403
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}404Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 404
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}406Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 406
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}422Headers
Content-Type: application/jsonBody
{
"message": "Descriptive error message",
"status_code": 422,
"errors": [
"Error message"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
},
"errors": {
"type": "array"
}
}
}500Headers
Content-Type: application/jsonBody
{
"message": "Internal Error",
"status_code": 500
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}DeleteDELETE/psos/{dataOwner}/form-instances/{formInstance}/fields/{field}/values
Clear value answered by user(dataOwner) on field in form.
Example URI
- dataOwner
number(required) Example: 123Id of PSO who will own the value.
- formInstance
number(required) Example: 123Id of Form Instance.
- field
number(required) Example: 123Id of Field.
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>204Headers
Content-Type: application/json401Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 401
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}403Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 403
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}404Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 404
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}406Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 406
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}422Headers
Content-Type: application/jsonBody
{
"message": "Descriptive error message",
"status_code": 422,
"errors": [
"Error message"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
},
"errors": {
"type": "array"
}
}
}500Headers
Content-Type: application/jsonBody
{
"message": "Internal Error",
"status_code": 500
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}UpdatePATCH/psos/{dataOwner}/form-instances/{formInstance}/fields/{field}/values
Update values of answers of user(data owner) on field in form.
Example URI
- dataOwner
number(required) Example: 123Id of PSO who will own the value.
- formInstance
number(required) Example: 123Id of Form Instance.
- field
number(required) Example: 123Id of Field.
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>Body
{
"id": 1,
"name": "Field Name",
"position": 5,
"alias": "usr_first_name",
"has_unique_data": false,
"has_value": true,
"removable": false,
"is_active": true,
"list": false,
"read_only": false,
"required": true,
"type": {
"id": 1,
"name": "Data Type Name",
"alias": "data_type_alias",
"settings": [
{
"id": 1,
"name": "Data Type Setting Name",
"alias": "data_type_setting_alias",
"is_required": true
}
],
"supports_collection": false,
"supports_read_only": false,
"supports_unique": false
},
"category": {
"id": 32,
"alias": "usr_identity",
"position": 5,
"system_required": true,
"name": "Identity",
"description": "...",
"is_active": true,
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
}
},
"domains": [
{
"id": 46,
"alias": "usr_global",
"name": "User Global",
"description": "...",
"is_editable": false,
"is_removable": false,
"is_active": true,
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
}
}
],
"privacy_level": {
"id": 123,
"alias": "public",
"name": "Not Sensitive",
"level": 100
},
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
},
"items": [
{}
],
"options": [
{
"id": 198,
"name": "Chose me!",
"position": 9,
"value": "198",
"is_active": true
}
],
"settings": []
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"position": {
"type": "number"
},
"alias": {
"type": "string"
},
"has_unique_data": {
"type": "boolean",
"description": "whether field requires values to be unique across system"
},
"has_value": {
"type": "boolean",
"description": "whether field has at least one value submitted"
},
"removable": {
"type": "boolean",
"description": "whether field can be removed from system"
},
"is_active": {
"type": "boolean"
},
"list": {
"type": "boolean",
"description": "whether field can handle collection of values"
},
"read_only": {
"type": "boolean",
"description": "whether field value can be changed"
},
"required": {
"type": "boolean",
"description": "whether field value required by system"
},
"type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"settings": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"is_required": {
"type": "boolean"
}
},
"required": [
"id",
"name",
"alias",
"is_required"
]
}
},
"supports_collection": {
"type": "boolean"
},
"supports_read_only": {
"type": "boolean"
},
"supports_unique": {
"type": "boolean"
}
},
"required": [
"id",
"name",
"alias",
"settings",
"supports_collection",
"supports_read_only",
"supports_unique"
],
"additionalProperties": false
},
"category": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"alias": {
"type": "string"
},
"position": {
"type": "number"
},
"system_required": {
"type": "boolean"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"pso_type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"system_required": {
"type": "boolean"
},
"creation_form_instance_id": {
"type": "number"
},
"profile_form_instance_id": {
"type": "number"
}
},
"required": [
"id",
"name",
"alias",
"description",
"is_active",
"system_required",
"creation_form_instance_id",
"profile_form_instance_id"
],
"additionalProperties": false
}
},
"required": [
"id",
"alias",
"position",
"system_required",
"name",
"description",
"is_active"
],
"additionalProperties": false
},
"domains": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"alias": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"is_editable": {
"type": "boolean"
},
"is_removable": {
"type": "boolean"
},
"is_active": {
"type": "boolean"
},
"pso_type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"system_required": {
"type": "boolean"
},
"creation_form_instance_id": {
"type": "number"
},
"profile_form_instance_id": {
"type": "number"
}
},
"required": [
"id",
"name",
"alias",
"description",
"is_active",
"system_required",
"creation_form_instance_id",
"profile_form_instance_id"
],
"additionalProperties": false
}
},
"required": [
"id",
"alias",
"name",
"description",
"is_editable",
"is_removable",
"is_active"
]
}
},
"privacy_level": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"alias": {
"type": "string"
},
"name": {
"type": "string"
},
"level": {
"type": "number"
}
},
"required": [
"id",
"alias",
"name",
"level"
],
"additionalProperties": false
},
"pso_type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"system_required": {
"type": "boolean"
},
"creation_form_instance_id": {
"type": "number"
},
"profile_form_instance_id": {
"type": "number"
}
},
"required": [
"id",
"name",
"alias",
"description",
"is_active",
"system_required",
"creation_form_instance_id",
"profile_form_instance_id"
],
"additionalProperties": false
},
"items": {
"type": [
"array",
"null"
],
"items": {
"type": "object",
"properties": {}
}
},
"options": {
"type": [
"array",
"null"
],
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"position": {
"type": "number"
},
"value": {
"type": "string"
},
"is_active": {
"type": "boolean"
}
},
"required": [
"id",
"name",
"position",
"value",
"is_active"
]
},
"description": "List of options with possible (allowed) values."
},
"settings": {
"type": "array",
"items": {
"type": "string"
},
"description": "Common field settings"
}
},
"required": [
"id",
"name",
"position",
"alias",
"has_unique_data",
"has_value",
"removable",
"is_active",
"list",
"read_only",
"required"
]
}202Headers
Content-Type: application/json400Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 400
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}401Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 401
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}403Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 403
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}404Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 404
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}406Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 406
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}422Headers
Content-Type: application/jsonBody
{
"message": "Descriptive error message",
"status_code": 422,
"errors": [
"Error message"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
},
"errors": {
"type": "array"
}
}
}500Headers
Content-Type: application/jsonBody
{
"message": "Internal Error",
"status_code": 500
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}Files ¶
Upload files to using it in answers.
Files ¶
CreatePOST/files/{type}
Upload a new file.
Example URI
- type
users, users_default, news, messages, logo(optional) Example: usersYou could provide it to specify entity of file
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>Body
{
"name": "image.jpg",
"file": {}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"name": {
"type": "string"
},
"file": {
"type": "object",
"properties": {},
"description": "file to upload. Max size 5 megabytes."
}
},
"required": [
"file"
]
}201Headers
Content-Type: application/jsonBody
{
"data": {
"name": "image.jpg",
"url": "http://example.com/images/logo.jpg"
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"name",
"url"
],
"additionalProperties": false
}
}
}400Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 400
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}401Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 401
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}403Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 403
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}404Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 404
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}406Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 406
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}422Headers
Content-Type: application/jsonBody
{
"message": "Descriptive error message",
"status_code": 422,
"errors": [
"Error message"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
},
"errors": {
"type": "array"
}
}
}500Headers
Content-Type: application/jsonBody
{
"message": "Internal Error",
"status_code": 500
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}Forms ¶
Forms allow to group fields which is make them easy to use Forms also allows to set view/edit restriction on fields
Management Permissions:
-
forms.view- Allows to view forms -
forms.create.*- Allows to create forms -
forms.edit.*- Allows to update forms -
forms.delete.*- Allows to delete forms
Forms ¶
Common ListGET/forms{?name,pso-type,active,include-standard,sort-by,sort-direction,page,per-page,no-pagination}
Get list of forms matches specified filters
Example URI
- sort-by
name(optional) Example: name- sort-direction
asc, desc(optional) Example: asc- active
boolean(optional) Example: true- name
string(optional) Example: form name to search on- include-standard
boolean(optional) Example: trueInclude creation and profile forms
- pso-type
string(optional) Example: usrPSO type alias to filtering
- page
number(required) Example: 1Page number.
1by default- per-page
number(required) Example: 10Number of items per page,
25by default- no-pagination
boolean(required) Example: falseif presented and positive pagination will not be applied. All available items will be returned.
Note: it may have significant impact on the performance
Note: once this option positive and presented -
metaattribute with pagination data will be omit in response
Headers
Accept: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target permission>200Headers
Content-Type: application/jsonBody
{
"data": [
{
"id": 1,
"name": "Form Name",
"description": "Form Description",
"is_active": true,
"removable": true,
"has_assigned": true,
"fields": [
{
"id": 1,
"name": "Field Name",
"position": 5,
"alias": "usr_first_name",
"has_unique_data": false,
"has_value": true,
"removable": false,
"is_active": true,
"list": false,
"read_only": false,
"required": true,
"type": {
"id": 1,
"name": "Data Type Name",
"alias": "data_type_alias",
"settings": [
{
"id": 1,
"name": "Data Type Setting Name",
"alias": "data_type_setting_alias",
"is_required": true
}
],
"supports_collection": false,
"supports_read_only": false,
"supports_unique": false
},
"category": {
"id": 32,
"alias": "usr_identity",
"position": 5,
"system_required": true,
"name": "Identity",
"description": "...",
"is_active": true,
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
}
},
"domains": [
{
"id": 46,
"alias": "usr_global",
"name": "User Global",
"description": "...",
"is_editable": false,
"is_removable": false,
"is_active": true,
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
}
}
],
"privacy_level": {
"id": 123,
"alias": "public",
"name": "Not Sensitive",
"level": 100
},
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
},
"items": [
{}
],
"options": [
{
"id": 198,
"name": "Chose me!",
"position": 9,
"value": "198",
"is_active": true
}
],
"settings": []
}
],
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
}
}
],
"meta": {
"pagination": {
"total": 238,
"count": 25,
"per_page": 25,
"current_page": 2,
"total_pages": 10,
"links": {
"previous": "http://example.com/api/<endpoint>?page=1",
"next": "http://example.com/api/<endpoint>?page=3"
}
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"removable": {
"type": "boolean"
},
"has_assigned": {
"type": "boolean"
},
"fields": {
"type": "array"
},
"pso_type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"system_required": {
"type": "boolean"
},
"creation_form_instance_id": {
"type": "number"
},
"profile_form_instance_id": {
"type": "number"
}
},
"required": [
"id",
"name",
"alias",
"description",
"is_active",
"system_required",
"creation_form_instance_id",
"profile_form_instance_id"
]
}
},
"required": [
"id",
"name",
"description",
"is_active",
"removable",
"has_assigned"
]
}
},
"meta": {
"type": "object",
"properties": {
"pagination": {
"type": "object",
"properties": {
"total": {
"type": "number"
},
"count": {
"type": "number"
},
"per_page": {
"type": "number"
},
"current_page": {
"type": "number"
},
"total_pages": {
"type": "number"
},
"links": {
"type": "object",
"properties": {
"previous": {
"type": "string"
},
"next": {
"type": "string"
}
},
"required": [
"previous",
"next"
]
}
},
"required": [
"total",
"count",
"per_page",
"current_page",
"total_pages",
"links"
],
"additionalProperties": false
}
},
"required": [
"pagination"
]
}
}
}401Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 401
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}403Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 403
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}404Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 404
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}406Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 406
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}422Headers
Content-Type: application/jsonBody
{
"message": "Descriptive error message",
"status_code": 422,
"errors": [
"Error message"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
},
"errors": {
"type": "array"
}
}
}500Headers
Content-Type: application/jsonBody
{
"message": "Internal Error",
"status_code": 500
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}ShowGET/forms/{id}
Get details for selected form
Example URI
- id
string(required) Example: 123
Headers
Accept: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target permission>200Headers
Content-Type: application/jsonBody
{
"data": {
"id": 1,
"name": "Form Name",
"description": "Form Description",
"is_active": true,
"removable": true,
"has_assigned": true,
"fields": [
{
"id": 1,
"name": "Field Name",
"position": 5,
"alias": "usr_first_name",
"has_unique_data": false,
"has_value": true,
"removable": false,
"is_active": true,
"list": false,
"read_only": false,
"required": true,
"type": {
"id": 1,
"name": "Data Type Name",
"alias": "data_type_alias",
"settings": [
{
"id": 1,
"name": "Data Type Setting Name",
"alias": "data_type_setting_alias",
"is_required": true
}
],
"supports_collection": false,
"supports_read_only": false,
"supports_unique": false
},
"category": {
"id": 32,
"alias": "usr_identity",
"position": 5,
"system_required": true,
"name": "Identity",
"description": "...",
"is_active": true,
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
}
},
"domains": [
{
"id": 46,
"alias": "usr_global",
"name": "User Global",
"description": "...",
"is_editable": false,
"is_removable": false,
"is_active": true,
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
}
}
],
"privacy_level": {
"id": 123,
"alias": "public",
"name": "Not Sensitive",
"level": 100
},
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
},
"items": [
{}
],
"options": [
{
"id": 198,
"name": "Chose me!",
"position": 9,
"value": "198",
"is_active": true
}
],
"settings": []
}
],
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"removable": {
"type": "boolean"
},
"has_assigned": {
"type": "boolean"
},
"fields": {
"type": "array"
},
"pso_type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"system_required": {
"type": "boolean"
},
"creation_form_instance_id": {
"type": "number"
},
"profile_form_instance_id": {
"type": "number"
}
},
"required": [
"id",
"name",
"alias",
"description",
"is_active",
"system_required",
"creation_form_instance_id",
"profile_form_instance_id"
]
}
},
"required": [
"id",
"name",
"description",
"is_active",
"removable",
"has_assigned"
]
}
}
}401Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 401
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}403Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 403
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}404Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 404
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}406Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 406
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}422Headers
Content-Type: application/jsonBody
{
"message": "Descriptive error message",
"status_code": 422,
"errors": [
"Error message"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
},
"errors": {
"type": "array"
}
}
}500Headers
Content-Type: application/jsonBody
{
"message": "Internal Error",
"status_code": 500
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}CreatePOST/forms
Create new form
Example URI
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>Body
{
"name": {
"en": "Some text",
"fr": "Du texte",
"de": "Setwas Text",
"es": "Algún texto"
},
"description": {
"en": "Some text",
"fr": "Du texte",
"de": "Setwas Text",
"es": "Algún texto"
},
"is_active": true,
"pso_type": "usr",
"fields": {
"field_id": 1,
"position": 1,
"settings": [
{
"id": 1,
"alias": "setting_alias",
"name": "Setting Name"
}
],
"permissions": [
{
"id": 1,
"alias": "feature_alias",
"name": "Feature Name"
}
]
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"name": {
"type": "object",
"properties": {
"en": {
"type": "string"
},
"fr": {
"type": "string"
},
"de": {
"type": "string"
},
"es": {
"type": "string"
}
},
"required": [
"en",
"fr",
"de",
"es"
]
},
"description": {
"type": "object",
"properties": {
"en": {
"type": "string"
},
"fr": {
"type": "string"
},
"de": {
"type": "string"
},
"es": {
"type": "string"
}
},
"required": [
"en",
"fr",
"de",
"es"
]
},
"is_active": {
"type": "boolean"
},
"pso_type": {
"type": "string"
},
"fields": {
"type": "object",
"properties": {
"field_id": {
"type": "number"
},
"position": {
"type": "number"
},
"settings": {
"type": "array"
},
"permissions": {
"type": "array"
}
},
"required": [
"field_id",
"position",
"settings",
"permissions"
]
}
},
"required": [
"name",
"description",
"is_active",
"pso_type",
"fields"
]
}201Headers
Content-Type: application/jsonBody
{
"data": {
"id": 1,
"name": "Form Name",
"description": "Form Description",
"is_active": true,
"removable": true,
"has_assigned": true,
"fields": [
{
"id": 1,
"name": "Field Name",
"position": 5,
"alias": "usr_first_name",
"has_unique_data": false,
"has_value": true,
"removable": false,
"is_active": true,
"list": false,
"read_only": false,
"required": true,
"type": {
"id": 1,
"name": "Data Type Name",
"alias": "data_type_alias",
"settings": [
{
"id": 1,
"name": "Data Type Setting Name",
"alias": "data_type_setting_alias",
"is_required": true
}
],
"supports_collection": false,
"supports_read_only": false,
"supports_unique": false
},
"category": {
"id": 32,
"alias": "usr_identity",
"position": 5,
"system_required": true,
"name": "Identity",
"description": "...",
"is_active": true,
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
}
},
"domains": [
{
"id": 46,
"alias": "usr_global",
"name": "User Global",
"description": "...",
"is_editable": false,
"is_removable": false,
"is_active": true,
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
}
}
],
"privacy_level": {
"id": 123,
"alias": "public",
"name": "Not Sensitive",
"level": 100
},
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
},
"items": [
{}
],
"options": [
{
"id": 198,
"name": "Chose me!",
"position": 9,
"value": "198",
"is_active": true
}
],
"settings": []
}
],
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"removable": {
"type": "boolean"
},
"has_assigned": {
"type": "boolean"
},
"fields": {
"type": "array"
},
"pso_type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"system_required": {
"type": "boolean"
},
"creation_form_instance_id": {
"type": "number"
},
"profile_form_instance_id": {
"type": "number"
}
},
"required": [
"id",
"name",
"alias",
"description",
"is_active",
"system_required",
"creation_form_instance_id",
"profile_form_instance_id"
]
}
},
"required": [
"id",
"name",
"description",
"is_active",
"removable",
"has_assigned"
],
"additionalProperties": false
}
}
}400Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 400
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}401Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 401
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}403Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 403
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}404Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 404
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}406Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 406
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}422Headers
Content-Type: application/jsonBody
{
"message": "Descriptive error message",
"status_code": 422,
"errors": [
"Error message"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
},
"errors": {
"type": "array"
}
}
}500Headers
Content-Type: application/jsonBody
{
"message": "Internal Error",
"status_code": 500
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}UpdatePOST/forms/{id}
Update form
Example URI
- id
string(required) Example: 123
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>Body
{
"name": {
"en": "Some text",
"fr": "Du texte",
"de": "Setwas Text",
"es": "Algún texto"
},
"description": {
"en": "Some text",
"fr": "Du texte",
"de": "Setwas Text",
"es": "Algún texto"
},
"is_active": true,
"fields": {
"field_id": 1,
"position": 1,
"settings": [
{
"id": 1,
"alias": "setting_alias",
"name": "Setting Name"
}
],
"permissions": [
{
"id": 1,
"alias": "feature_alias",
"name": "Feature Name"
}
]
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"name": {
"type": "object",
"properties": {
"en": {
"type": "string"
},
"fr": {
"type": "string"
},
"de": {
"type": "string"
},
"es": {
"type": "string"
}
},
"required": [
"en",
"fr",
"de",
"es"
]
},
"description": {
"type": "object",
"properties": {
"en": {
"type": "string"
},
"fr": {
"type": "string"
},
"de": {
"type": "string"
},
"es": {
"type": "string"
}
},
"required": [
"en",
"fr",
"de",
"es"
]
},
"is_active": {
"type": "boolean"
},
"fields": {
"type": "object",
"properties": {
"field_id": {
"type": "number"
},
"position": {
"type": "number"
},
"settings": {
"type": "array"
},
"permissions": {
"type": "array"
}
},
"required": [
"field_id",
"position",
"settings",
"permissions"
]
}
}
}202Headers
Content-Type: application/jsonBody
{
"data": {
"id": 1,
"name": "Form Name",
"description": "Form Description",
"is_active": true,
"removable": true,
"has_assigned": true,
"fields": [
{
"id": 1,
"name": "Field Name",
"position": 5,
"alias": "usr_first_name",
"has_unique_data": false,
"has_value": true,
"removable": false,
"is_active": true,
"list": false,
"read_only": false,
"required": true,
"type": {
"id": 1,
"name": "Data Type Name",
"alias": "data_type_alias",
"settings": [
{
"id": 1,
"name": "Data Type Setting Name",
"alias": "data_type_setting_alias",
"is_required": true
}
],
"supports_collection": false,
"supports_read_only": false,
"supports_unique": false
},
"category": {
"id": 32,
"alias": "usr_identity",
"position": 5,
"system_required": true,
"name": "Identity",
"description": "...",
"is_active": true,
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
}
},
"domains": [
{
"id": 46,
"alias": "usr_global",
"name": "User Global",
"description": "...",
"is_editable": false,
"is_removable": false,
"is_active": true,
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
}
}
],
"privacy_level": {
"id": 123,
"alias": "public",
"name": "Not Sensitive",
"level": 100
},
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
},
"items": [
{}
],
"options": [
{
"id": 198,
"name": "Chose me!",
"position": 9,
"value": "198",
"is_active": true
}
],
"settings": []
}
],
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"removable": {
"type": "boolean"
},
"has_assigned": {
"type": "boolean"
},
"fields": {
"type": "array"
},
"pso_type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"system_required": {
"type": "boolean"
},
"creation_form_instance_id": {
"type": "number"
},
"profile_form_instance_id": {
"type": "number"
}
},
"required": [
"id",
"name",
"alias",
"description",
"is_active",
"system_required",
"creation_form_instance_id",
"profile_form_instance_id"
]
}
},
"required": [
"id",
"name",
"description",
"is_active",
"removable",
"has_assigned"
],
"additionalProperties": false
}
}
}400Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 400
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}401Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 401
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}403Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 403
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}404Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 404
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}406Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 406
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}422Headers
Content-Type: application/jsonBody
{
"message": "Descriptive error message",
"status_code": 422,
"errors": [
"Error message"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
},
"errors": {
"type": "array"
}
}
}500Headers
Content-Type: application/jsonBody
{
"message": "Internal Error",
"status_code": 500
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}DeleteDELETE/form/{id}
Remove form
Example URI
- id
string(required) Example: 123
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>204Headers
Content-Type: application/json400Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 400
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}401Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 401
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}403Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 403
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}404Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 404
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}406Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 406
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}422Headers
Content-Type: application/jsonBody
{
"message": "Descriptive error message",
"status_code": 422,
"errors": [
"Error message"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
},
"errors": {
"type": "array"
}
}
}500Headers
Content-Type: application/jsonBody
{
"message": "Internal Error",
"status_code": 500
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}Detach one fieldDELETE/form/{form}/fields/{field}
Detach a single field from form
Example URI
- form
number(required) Example: 123form id
- field
number(required) Example: 123field id
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>204Headers
Content-Type: application/json400Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 400
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}401Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 401
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}403Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 403
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}404Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 404
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}406Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 406
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}422Headers
Content-Type: application/jsonBody
{
"message": "Descriptive error message",
"status_code": 422,
"errors": [
"Error message"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
},
"errors": {
"type": "array"
}
}
}500Headers
Content-Type: application/jsonBody
{
"message": "Internal Error",
"status_code": 500
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}Detach FieldsDELETE/form/{form}/fields/
Detach fields from form
Example URI
- form
number(required) Example: 123form id
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>Body
[
1
]Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array"
}202Headers
Content-Type: application/json400Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 400
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}401Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 401
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}403Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 403
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}404Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 404
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}406Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 406
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}422Headers
Content-Type: application/jsonBody
{
"message": "Descriptive error message",
"status_code": 422,
"errors": [
"Error message"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
},
"errors": {
"type": "array"
}
}
}500Headers
Content-Type: application/jsonBody
{
"message": "Internal Error",
"status_code": 500
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}Create AssignmentPOST/forms/{id}/instances
Assign users to form
Requested user permissions:
form_assignments.view
Example URI
- id
string(required) Example: 123form id
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>Body
{
"name": {
"en": "Some text",
"fr": "Du texte",
"de": "Setwas Text",
"es": "Algún texto"
},
"description": {
"en": "Some text",
"fr": "Du texte",
"de": "Setwas Text",
"es": "Algún texto"
},
"rules": {
"access_rule_type_id": 1,
"value": "Hello, world!"
},
"workflow_steps": {
"step": 1,
"relation": "mentor"
},
"settings": [
{
"id": 1,
"alias": "setting_alias",
"name": "Setting Name"
}
],
"is_hidden": false
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"name": {
"type": "object",
"properties": {
"en": {
"type": "string"
},
"fr": {
"type": "string"
},
"de": {
"type": "string"
},
"es": {
"type": "string"
}
},
"required": [
"en",
"fr",
"de",
"es"
]
},
"description": {
"type": "object",
"properties": {
"en": {
"type": "string"
},
"fr": {
"type": "string"
},
"de": {
"type": "string"
},
"es": {
"type": "string"
}
},
"required": [
"en",
"fr",
"de",
"es"
]
},
"rules": {
"type": "object",
"properties": {
"access_rule_type_id": {
"type": "number"
},
"value": {
"type": "string"
}
},
"required": [
"access_rule_type_id",
"value"
]
},
"workflow_steps": {
"type": "object",
"properties": {
"step": {
"type": "number"
},
"relation": {
"type": "string"
}
},
"required": [
"step",
"relation"
]
},
"settings": {
"type": "array"
},
"is_hidden": {
"type": "boolean"
}
},
"required": [
"rules",
"workflow_steps",
"settings",
"is_hidden"
]
}201Headers
Content-Type: application/jsonBody
{
"data": {
"id": 1,
"name": "Form Assignment Name",
"description": "Form Assignment Description",
"form_id": 12,
"is_active": true,
"removable": true,
"settings": [
{
"id": 1,
"alias": "setting_alias",
"name": "Setting Name"
}
],
"access_rules": [
{
"id": 123,
"access_rule_type": {
"id": 1,
"alias": "population_type_alias",
"name": "Population Type Name"
},
"value": ""
}
],
"population_type": [
{
"id": 1,
"alias": "population_type_alias",
"name": "Population Type Name"
}
],
"workflow_steps": {
"relation": "hr",
"step": 1,
"field": {
"id": 1,
"name": "Field Name",
"position": 5,
"alias": "usr_first_name",
"has_unique_data": false,
"has_value": true,
"removable": false,
"is_active": true,
"list": false,
"read_only": false,
"required": true,
"type": {
"id": 1,
"name": "Data Type Name",
"alias": "data_type_alias",
"settings": [
{
"id": 1,
"name": "Data Type Setting Name",
"alias": "data_type_setting_alias",
"is_required": true
}
],
"supports_collection": false,
"supports_read_only": false,
"supports_unique": false
},
"category": {
"id": 32,
"alias": "usr_identity",
"position": 5,
"system_required": true,
"name": "Identity",
"description": "...",
"is_active": true,
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
}
},
"domains": [
{
"id": 46,
"alias": "usr_global",
"name": "User Global",
"description": "...",
"is_editable": false,
"is_removable": false,
"is_active": true,
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
}
}
],
"privacy_level": {
"id": 123,
"alias": "public",
"name": "Not Sensitive",
"level": 100
},
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
},
"items": [
{}
],
"options": [
{
"id": 198,
"name": "Chose me!",
"position": 9,
"value": "198",
"is_active": true
}
],
"settings": []
}
},
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
},
"population_details": {
"dynamic": false,
"includes": [
"1",
"2"
],
"excludes": [
"3",
"4"
],
"specific_psos": [
5,
6
]
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"form_id": {
"type": "number"
},
"is_active": {
"type": "boolean"
},
"removable": {
"type": "boolean"
},
"settings": {
"type": "array"
},
"access_rules": {
"type": "array"
},
"population_type": {
"type": "array"
},
"workflow_steps": {
"type": "object",
"properties": {
"relation": {
"type": "string"
},
"step": {
"type": "number"
},
"field": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"position": {
"type": "number"
},
"alias": {
"type": "string"
},
"has_unique_data": {
"type": "boolean",
"description": "whether field requires values to be unique across system"
},
"has_value": {
"type": "boolean",
"description": "whether field has at least one value submitted"
},
"removable": {
"type": "boolean",
"description": "whether field can be removed from system"
},
"is_active": {
"type": "boolean"
},
"list": {
"type": "boolean",
"description": "whether field can handle collection of values"
},
"read_only": {
"type": "boolean",
"description": "whether field value can be changed"
},
"required": {
"type": "boolean",
"description": "whether field value required by system"
},
"type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"settings": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"is_required": {
"type": "boolean"
}
},
"required": [
"id",
"name",
"alias",
"is_required"
]
}
},
"supports_collection": {
"type": "boolean"
},
"supports_read_only": {
"type": "boolean"
},
"supports_unique": {
"type": "boolean"
}
},
"required": [
"id",
"name",
"alias",
"settings",
"supports_collection",
"supports_read_only",
"supports_unique"
],
"additionalProperties": false
},
"category": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"alias": {
"type": "string"
},
"position": {
"type": "number"
},
"system_required": {
"type": "boolean"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"pso_type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"system_required": {
"type": "boolean"
},
"creation_form_instance_id": {
"type": "number"
},
"profile_form_instance_id": {
"type": "number"
}
},
"required": [
"id",
"name",
"alias",
"description",
"is_active",
"system_required",
"creation_form_instance_id",
"profile_form_instance_id"
],
"additionalProperties": false
}
},
"required": [
"id",
"alias",
"position",
"system_required",
"name",
"description",
"is_active"
],
"additionalProperties": false
},
"domains": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"alias": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"is_editable": {
"type": "boolean"
},
"is_removable": {
"type": "boolean"
},
"is_active": {
"type": "boolean"
},
"pso_type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"system_required": {
"type": "boolean"
},
"creation_form_instance_id": {
"type": "number"
},
"profile_form_instance_id": {
"type": "number"
}
},
"required": [
"id",
"name",
"alias",
"description",
"is_active",
"system_required",
"creation_form_instance_id",
"profile_form_instance_id"
],
"additionalProperties": false
}
},
"required": [
"id",
"alias",
"name",
"description",
"is_editable",
"is_removable",
"is_active"
]
}
},
"privacy_level": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"alias": {
"type": "string"
},
"name": {
"type": "string"
},
"level": {
"type": "number"
}
},
"required": [
"id",
"alias",
"name",
"level"
],
"additionalProperties": false
},
"pso_type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"system_required": {
"type": "boolean"
},
"creation_form_instance_id": {
"type": "number"
},
"profile_form_instance_id": {
"type": "number"
}
},
"required": [
"id",
"name",
"alias",
"description",
"is_active",
"system_required",
"creation_form_instance_id",
"profile_form_instance_id"
],
"additionalProperties": false
},
"items": {
"type": [
"array",
"null"
],
"items": {
"type": "object",
"properties": {}
}
},
"options": {
"type": [
"array",
"null"
],
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"position": {
"type": "number"
},
"value": {
"type": "string"
},
"is_active": {
"type": "boolean"
}
},
"required": [
"id",
"name",
"position",
"value",
"is_active"
]
},
"description": "List of options with possible (allowed) values."
},
"settings": {
"type": "array",
"items": {
"type": "string"
},
"description": "Common field settings"
}
},
"required": [
"id",
"name",
"position",
"alias",
"has_unique_data",
"has_value",
"removable",
"is_active",
"list",
"read_only",
"required"
]
}
},
"required": [
"relation",
"step"
]
},
"pso_type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"system_required": {
"type": "boolean"
},
"creation_form_instance_id": {
"type": "number"
},
"profile_form_instance_id": {
"type": "number"
}
},
"required": [
"id",
"name",
"alias",
"description",
"is_active",
"system_required",
"creation_form_instance_id",
"profile_form_instance_id"
]
},
"population_details": {
"type": "object",
"properties": {
"dynamic": {
"type": "boolean"
},
"includes": {
"type": "array"
},
"excludes": {
"type": "array"
},
"specific_psos": {
"type": "array"
}
},
"required": [
"dynamic",
"includes",
"excludes",
"specific_psos"
]
}
},
"required": [
"id",
"name",
"description",
"form_id",
"is_active",
"removable",
"population_type",
"population_details"
],
"additionalProperties": false
}
}
}400Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 400
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}401Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 401
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}403Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 403
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}404Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 404
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}406Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 406
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}422Headers
Content-Type: application/jsonBody
{
"message": "Descriptive error message",
"status_code": 422,
"errors": [
"Error message"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
},
"errors": {
"type": "array"
}
}
}500Headers
Content-Type: application/jsonBody
{
"message": "Internal Error",
"status_code": 500
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}Form instances ¶
Form instances
Form instances ¶
ListGET/form-instances{?name,active,with-hidden,assignment-type,pso-type,include,sort-by,sort-direction,page,per-page,no-pagination}
Fetch list of Form instances
Example URI
- name
string(required) Example: 'Some name'- active
boolean(required) Example: true- with-hidden
boolean(required) Example: true- assignment-type
string(required) Example: 'Some name'Possible values:
poll,permanent,unique,periodic- pso-type
string(required) Example: some_type- include
string(optional) Example: settings, access_rules, workflow_steps- sort-by
string(required) Example: 'name'Field to sort by. Possible values:
name- sort-direction
string(required) Example: 'asc'Direction to order results by. Possible values:
asc,desc- page
number(required) Example: 1Page number.
1by default- per-page
number(required) Example: 10Number of items per page,
25by default- no-pagination
boolean(required) Example: falseif presented and positive pagination will not be applied. All available items will be returned.
Note: it may have significant impact on the performance
Note: once this option positive and presented -
metaattribute with pagination data will be omit in response
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>200Headers
Content-Type: application/jsonBody
{
"data": [
{
"id": 1,
"name": {
"en": "Some text",
"fr": "Du texte",
"de": "Setwas Text",
"es": "Algún texto"
},
"description": {
"en": "Some text",
"fr": "Du texte",
"de": "Setwas Text",
"es": "Algún texto"
},
"form_id": 123,
"is_active": true,
"removable": false,
"effective_date": "2019-04-24 11:47:47"
}
],
"meta": {
"pagination": {
"total": 238,
"count": 25,
"per_page": 25,
"current_page": 2,
"total_pages": 10,
"links": {
"previous": "http://example.com/api/<endpoint>?page=1",
"next": "http://example.com/api/<endpoint>?page=3"
}
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "object",
"properties": {
"en": {
"type": "string"
},
"fr": {
"type": "string"
},
"de": {
"type": "string"
},
"es": {
"type": "string"
}
},
"required": [
"en",
"fr",
"de",
"es"
]
},
"description": {
"type": "object",
"properties": {
"en": {
"type": "string"
},
"fr": {
"type": "string"
},
"de": {
"type": "string"
},
"es": {
"type": "string"
}
},
"required": [
"en",
"fr",
"de",
"es"
]
},
"form_id": {
"type": "number"
},
"is_active": {
"type": "boolean"
},
"removable": {
"type": "boolean"
},
"effective_date": {
"type": "string"
}
},
"required": [
"id",
"name",
"description",
"form_id",
"is_active",
"removable"
]
}
},
"meta": {
"type": "object",
"properties": {
"pagination": {
"type": "object",
"properties": {
"total": {
"type": "number"
},
"count": {
"type": "number"
},
"per_page": {
"type": "number"
},
"current_page": {
"type": "number"
},
"total_pages": {
"type": "number"
},
"links": {
"type": "object",
"properties": {
"previous": {
"type": "string"
},
"next": {
"type": "string"
}
},
"required": [
"previous",
"next"
]
}
},
"required": [
"total",
"count",
"per_page",
"current_page",
"total_pages",
"links"
],
"additionalProperties": false
}
},
"required": [
"pagination"
]
}
}
}401Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 401
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}403Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 403
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}404Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 404
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}406Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 406
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}422Headers
Content-Type: application/jsonBody
{
"message": "Descriptive error message",
"status_code": 422,
"errors": [
"Error message"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
},
"errors": {
"type": "array"
}
}
}500Headers
Content-Type: application/jsonBody
{
"message": "Internal Error",
"status_code": 500
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}ShowGET/form-instances/{id}
Fetch single Form instance
Example URI
- id
number(required) Example: 123Id of the Idea.
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>200Headers
Content-Type: application/jsonBody
{
"data": {
"id": 1,
"name": {
"en": "Some text",
"fr": "Du texte",
"de": "Setwas Text",
"es": "Algún texto"
},
"description": {
"en": "Some text",
"fr": "Du texte",
"de": "Setwas Text",
"es": "Algún texto"
},
"form_id": 123,
"is_active": true,
"removable": false,
"effective_date": "2019-04-24 11:47:47"
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "object",
"properties": {
"en": {
"type": "string"
},
"fr": {
"type": "string"
},
"de": {
"type": "string"
},
"es": {
"type": "string"
}
},
"required": [
"en",
"fr",
"de",
"es"
]
},
"description": {
"type": "object",
"properties": {
"en": {
"type": "string"
},
"fr": {
"type": "string"
},
"de": {
"type": "string"
},
"es": {
"type": "string"
}
},
"required": [
"en",
"fr",
"de",
"es"
]
},
"form_id": {
"type": "number"
},
"is_active": {
"type": "boolean"
},
"removable": {
"type": "boolean"
},
"effective_date": {
"type": "string"
}
},
"required": [
"id",
"name",
"description",
"form_id",
"is_active",
"removable",
"effective_date"
],
"additionalProperties": false
}
}
}401Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 401
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}403Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 403
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}404Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 404
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}406Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 406
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}422Headers
Content-Type: application/jsonBody
{
"message": "Descriptive error message",
"status_code": 422,
"errors": [
"Error message"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
},
"errors": {
"type": "array"
}
}
}500Headers
Content-Type: application/jsonBody
{
"message": "Internal Error",
"status_code": 500
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}UpdatePATCH/form-instances/{id}
Update Form instance
Example URI
- id
number(required) Example: 123Id of the Form instance.
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>Body
{
"is_active": true,
"is_hidden": true
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"is_active": {
"type": "boolean"
},
"is_hidden": {
"type": "boolean"
}
},
"required": [
"is_hidden"
]
}200Headers
Content-Type: application/jsonBody
{
"data": {
"id": 1,
"name": {
"en": "Some text",
"fr": "Du texte",
"de": "Setwas Text",
"es": "Algún texto"
},
"description": {
"en": "Some text",
"fr": "Du texte",
"de": "Setwas Text",
"es": "Algún texto"
},
"form_id": 123,
"is_active": true,
"removable": false,
"effective_date": "2019-04-24 11:47:47"
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "object",
"properties": {
"en": {
"type": "string"
},
"fr": {
"type": "string"
},
"de": {
"type": "string"
},
"es": {
"type": "string"
}
},
"required": [
"en",
"fr",
"de",
"es"
]
},
"description": {
"type": "object",
"properties": {
"en": {
"type": "string"
},
"fr": {
"type": "string"
},
"de": {
"type": "string"
},
"es": {
"type": "string"
}
},
"required": [
"en",
"fr",
"de",
"es"
]
},
"form_id": {
"type": "number"
},
"is_active": {
"type": "boolean"
},
"removable": {
"type": "boolean"
},
"effective_date": {
"type": "string"
}
},
"required": [
"id",
"name",
"description",
"form_id",
"is_active",
"removable",
"effective_date"
],
"additionalProperties": false
}
}
}400Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 400
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}401Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 401
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}403Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 403
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}404Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 404
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}406Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 406
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}422Headers
Content-Type: application/jsonBody
{
"message": "Descriptive error message",
"status_code": 422,
"errors": [
"Error message"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
},
"errors": {
"type": "array"
}
}
}500Headers
Content-Type: application/jsonBody
{
"message": "Internal Error",
"status_code": 500
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}DeleteDELETE/form-instances/{id}
Delete Form instance
Example URI
- id
number(required) Example: 123Id of the Form instance.
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>204Headers
Content-Type: application/json401Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 401
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}403Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 403
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}404Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 404
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}406Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 406
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}422Headers
Content-Type: application/jsonBody
{
"message": "Descriptive error message",
"status_code": 422,
"errors": [
"Error message"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
},
"errors": {
"type": "array"
}
}
}500Headers
Content-Type: application/jsonBody
{
"message": "Internal Error",
"status_code": 500
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}Groups ¶
Fields categories.
Groups ¶
ListGET/groups{?pso-type,active,name,sort-by,sort-direction}
Fetch list of groups
Example URI
- pso-type
number(optional) Example: 123PSO type ID to filtering.
- active
boolean(optional) Example: trueTo filtering groups by active state
- name
string(optional) Example: Category to searchSearch by group title. Non strict, case-insensitive.
- sort-by
name, pso-type, status, owner(optional) Default: name Example: nameField to sort groups by.
- sort-direction
asc, desc(optional) Default: asc Example: ascDirection to order fields categories by.
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>200Headers
Content-Type: application/jsonBody
{
"data": [
{
"id": 32,
"name": "Group name",
"description": "...",
"alias": "usr_group",
"status": "ok",
"is_active": true,
"created_at": "2019-04-24 11:47:47",
"updated_at": "2019-04-24 11:47:47",
"processed_at": "2019-04-24 11:47:47",
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
},
"owner": {
"id": 1,
"external_id": 1,
"first_name": "John",
"last_name": "Snow",
"username": "john_snow",
"professional_email": "jsnow@example.com",
"professional_mobile_phone": "00 33 1 40 00 00 00",
"professional_phone": "00 33 1 40 00 00 00",
"role": [
"bastard",
"king"
],
"is_active": true,
"status": "remote",
"settings": [
"[]"
],
"user_photo": "http://example.com/images/1.jpg"
},
"specific_psos": [
{
"summary": {
"first_name": {
"id": 1,
"alias": "usr_first_name",
"value": "John"
},
"last_name": {
"id": 1,
"alias": "usr_first_name",
"value": "John"
},
"image": {
"id": 1,
"alias": "usr_first_name",
"value": "John"
},
"is_active": {
"id": 1,
"alias": "usr_first_name",
"value": "John"
},
"email": {
"id": 1,
"alias": "usr_first_name",
"value": "John"
},
"phone_number": ""
},
"pso": {
"id": 1,
"profile_form": {
"id": 1,
"name": "Profile Form",
"description": "Profile Form Description",
"is_active": true,
"active_field": "null"
},
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
},
"categories": [
{
"id": 1,
"name": "Category Name",
"alias": "category_alias"
}
],
"fields": {
"id": 1,
"name": "Field Name",
"position": 5,
"alias": "usr_first_name",
"has_unique_data": false,
"has_value": true,
"removable": false,
"is_active": true,
"list": false,
"read_only": false,
"required": true,
"type": {
"id": 1,
"name": "Data Type Name",
"alias": "data_type_alias",
"settings": [
{
"id": 1,
"name": "Data Type Setting Name",
"alias": "data_type_setting_alias",
"is_required": true
}
],
"supports_collection": false,
"supports_read_only": false,
"supports_unique": false
},
"category": {
"id": 32,
"alias": "usr_identity",
"position": 5,
"system_required": true,
"name": "Identity",
"description": "...",
"is_active": true,
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
}
},
"domains": [
{
"id": 46,
"alias": "usr_global",
"name": "User Global",
"description": "...",
"is_editable": false,
"is_removable": false,
"is_active": true,
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
}
}
],
"privacy_level": {
"id": 123,
"alias": "public",
"name": "Not Sensitive",
"level": 100
},
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
},
"items": [
{
"id": 1,
"name": "Field Name",
"position": 5,
"alias": "usr_first_name",
"has_unique_data": false,
"has_value": true,
"removable": false,
"is_active": true,
"list": false,
"read_only": false,
"required": true,
"type": {
"id": 1,
"name": "Data Type Name",
"alias": "data_type_alias",
"settings": [
{
"id": 1,
"name": "Data Type Setting Name",
"alias": "data_type_setting_alias",
"is_required": true
}
],
"supports_collection": false,
"supports_read_only": false,
"supports_unique": false
},
"category": {
"id": 32,
"alias": "usr_identity",
"position": 5,
"system_required": true,
"name": "Identity",
"description": "...",
"is_active": true,
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
}
},
"domains": [
{
"id": 46,
"alias": "usr_global",
"name": "User Global",
"description": "...",
"is_editable": false,
"is_removable": false,
"is_active": true,
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
}
}
],
"privacy_level": {
"id": 123,
"alias": "public",
"name": "Not Sensitive",
"level": 100
},
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
},
"items": [
{}
],
"options": [
{
"id": 198,
"name": "Chose me!",
"position": 9,
"value": "198",
"is_active": true
}
],
"settings": []
}
],
"options": [
{
"id": 198,
"name": "Chose me!",
"position": 9,
"value": "198",
"is_active": true
}
],
"settings": [],
"is_locked": false,
"value_details": [
"value1",
"value2"
],
"values_count": 2,
"assignment_settings": [
{
"setting": "public",
"value": "1"
}
],
"access_permissions": {
"history": true,
"view": true,
"edit": true
},
"assignment_permissions": {
"permissions": {
"id": 1,
"name": "View",
"alias": "view"
},
"access_list": [
"0",
"1",
"1"
]
}
}
}
}
],
"conditions": [
{
"type": "group",
"combine_with": "and",
"conditions": [
{
"type": "condition",
"field": "usr_email",
"raw_value": "john.doe@example.com",
"operator": "=="
}
]
}
],
"permissions": [
{
"can_edit": true,
"can_remove": true
}
]
}
],
"meta": {
"pagination": {
"total": 238,
"count": 25,
"per_page": 25,
"current_page": 2,
"total_pages": 10,
"links": {
"previous": "http://example.com/api/<endpoint>?page=1",
"next": "http://example.com/api/<endpoint>?page=3"
}
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"alias": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"ok",
"pending"
]
},
"is_active": {
"type": "boolean"
},
"created_at": {
"type": "string"
},
"updated_at": {
"type": "string"
},
"processed_at": {
"type": "string"
},
"pso_type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"system_required": {
"type": "boolean"
},
"creation_form_instance_id": {
"type": "number"
},
"profile_form_instance_id": {
"type": "number"
}
},
"required": [
"id",
"name",
"alias",
"description",
"is_active",
"system_required",
"creation_form_instance_id",
"profile_form_instance_id"
],
"additionalProperties": false
},
"owner": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"external_id": {
"type": "number"
},
"first_name": {
"type": "string"
},
"last_name": {
"type": "string"
},
"username": {
"type": "string"
},
"professional_email": {
"type": "string"
},
"professional_mobile_phone": {
"type": "string"
},
"professional_phone": {
"type": "string"
},
"role": {
"type": "array"
},
"is_active": {
"type": "boolean"
},
"status": {
"type": "string"
},
"settings": {
"type": "array"
},
"user_photo": {
"type": "string"
}
},
"required": [
"id",
"external_id",
"first_name",
"last_name",
"username",
"professional_email",
"professional_mobile_phone",
"professional_phone",
"role",
"is_active",
"status",
"settings",
"user_photo"
],
"additionalProperties": false
},
"specific_psos": {
"type": "array"
},
"conditions": {
"type": "array"
},
"permissions": {
"type": "array"
}
},
"required": [
"id",
"name",
"description",
"alias",
"status",
"is_active",
"created_at",
"updated_at",
"specific_psos",
"conditions"
]
}
},
"meta": {
"type": "object",
"properties": {
"pagination": {
"type": "object",
"properties": {
"total": {
"type": "number"
},
"count": {
"type": "number"
},
"per_page": {
"type": "number"
},
"current_page": {
"type": "number"
},
"total_pages": {
"type": "number"
},
"links": {
"type": "object",
"properties": {
"previous": {
"type": "string"
},
"next": {
"type": "string"
}
},
"required": [
"previous",
"next"
]
}
},
"required": [
"total",
"count",
"per_page",
"current_page",
"total_pages",
"links"
],
"additionalProperties": false
}
},
"required": [
"pagination"
]
}
}
}401Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 401
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}403Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 403
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}404Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 404
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}406Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 406
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}422Headers
Content-Type: application/jsonBody
{
"message": "Descriptive error message",
"status_code": 422,
"errors": [
"Error message"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
},
"errors": {
"type": "array"
}
}
}500Headers
Content-Type: application/jsonBody
{
"message": "Internal Error",
"status_code": 500
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}ShowGET/groups/{id}/history
Fetch information about changes in group. Supports pagination
Example URI
- id
number(required) Example: 123ID of the Group item.
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>200Headers
Content-Type: application/jsonBody
{
"data": [
{
"id": 32,
"name": "Group name",
"description": "...",
"alias": "usr_group",
"status": "ok",
"is_active": true,
"created_at": "2019-04-24 11:47:47",
"updated_at": "2019-04-24 11:47:47",
"processed_at": "2019-04-24 11:47:47",
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
},
"owner": {
"id": 1,
"external_id": 1,
"first_name": "John",
"last_name": "Snow",
"username": "john_snow",
"professional_email": "jsnow@example.com",
"professional_mobile_phone": "00 33 1 40 00 00 00",
"professional_phone": "00 33 1 40 00 00 00",
"role": [
"bastard",
"king"
],
"is_active": true,
"status": "remote",
"settings": [
"[]"
],
"user_photo": "http://example.com/images/1.jpg"
},
"specific_psos": [
{
"summary": {
"first_name": {
"id": 1,
"alias": "usr_first_name",
"value": "John"
},
"last_name": {
"id": 1,
"alias": "usr_first_name",
"value": "John"
},
"image": {
"id": 1,
"alias": "usr_first_name",
"value": "John"
},
"is_active": {
"id": 1,
"alias": "usr_first_name",
"value": "John"
},
"email": {
"id": 1,
"alias": "usr_first_name",
"value": "John"
},
"phone_number": ""
},
"pso": {
"id": 1,
"profile_form": {
"id": 1,
"name": "Profile Form",
"description": "Profile Form Description",
"is_active": true,
"active_field": "null"
},
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
},
"categories": [
{
"id": 1,
"name": "Category Name",
"alias": "category_alias"
}
],
"fields": {
"id": 1,
"name": "Field Name",
"position": 5,
"alias": "usr_first_name",
"has_unique_data": false,
"has_value": true,
"removable": false,
"is_active": true,
"list": false,
"read_only": false,
"required": true,
"type": {
"id": 1,
"name": "Data Type Name",
"alias": "data_type_alias",
"settings": [
{
"id": 1,
"name": "Data Type Setting Name",
"alias": "data_type_setting_alias",
"is_required": true
}
],
"supports_collection": false,
"supports_read_only": false,
"supports_unique": false
},
"category": {
"id": 32,
"alias": "usr_identity",
"position": 5,
"system_required": true,
"name": "Identity",
"description": "...",
"is_active": true,
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
}
},
"domains": [
{
"id": 46,
"alias": "usr_global",
"name": "User Global",
"description": "...",
"is_editable": false,
"is_removable": false,
"is_active": true,
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
}
}
],
"privacy_level": {
"id": 123,
"alias": "public",
"name": "Not Sensitive",
"level": 100
},
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
},
"items": [
{
"id": 1,
"name": "Field Name",
"position": 5,
"alias": "usr_first_name",
"has_unique_data": false,
"has_value": true,
"removable": false,
"is_active": true,
"list": false,
"read_only": false,
"required": true,
"type": {
"id": 1,
"name": "Data Type Name",
"alias": "data_type_alias",
"settings": [
{
"id": 1,
"name": "Data Type Setting Name",
"alias": "data_type_setting_alias",
"is_required": true
}
],
"supports_collection": false,
"supports_read_only": false,
"supports_unique": false
},
"category": {
"id": 32,
"alias": "usr_identity",
"position": 5,
"system_required": true,
"name": "Identity",
"description": "...",
"is_active": true,
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
}
},
"domains": [
{
"id": 46,
"alias": "usr_global",
"name": "User Global",
"description": "...",
"is_editable": false,
"is_removable": false,
"is_active": true,
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
}
}
],
"privacy_level": {
"id": 123,
"alias": "public",
"name": "Not Sensitive",
"level": 100
},
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
},
"items": [
{}
],
"options": [
{
"id": 198,
"name": "Chose me!",
"position": 9,
"value": "198",
"is_active": true
}
],
"settings": []
}
],
"options": [
{
"id": 198,
"name": "Chose me!",
"position": 9,
"value": "198",
"is_active": true
}
],
"settings": [],
"is_locked": false,
"value_details": [
"value1",
"value2"
],
"values_count": 2,
"assignment_settings": [
{
"setting": "public",
"value": "1"
}
],
"access_permissions": {
"history": true,
"view": true,
"edit": true
},
"assignment_permissions": {
"permissions": {
"id": 1,
"name": "View",
"alias": "view"
},
"access_list": [
"0",
"1",
"1"
]
}
}
}
}
],
"conditions": [
{
"type": "group",
"combine_with": "and",
"conditions": [
{
"type": "condition",
"field": "usr_email",
"raw_value": "john.doe@example.com",
"operator": "=="
}
]
}
],
"permissions": [
{
"can_edit": true,
"can_remove": true
}
]
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"alias": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"ok",
"pending"
]
},
"is_active": {
"type": "boolean"
},
"created_at": {
"type": "string"
},
"updated_at": {
"type": "string"
},
"processed_at": {
"type": "string"
},
"pso_type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"system_required": {
"type": "boolean"
},
"creation_form_instance_id": {
"type": "number"
},
"profile_form_instance_id": {
"type": "number"
}
},
"required": [
"id",
"name",
"alias",
"description",
"is_active",
"system_required",
"creation_form_instance_id",
"profile_form_instance_id"
],
"additionalProperties": false
},
"owner": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"external_id": {
"type": "number"
},
"first_name": {
"type": "string"
},
"last_name": {
"type": "string"
},
"username": {
"type": "string"
},
"professional_email": {
"type": "string"
},
"professional_mobile_phone": {
"type": "string"
},
"professional_phone": {
"type": "string"
},
"role": {
"type": "array"
},
"is_active": {
"type": "boolean"
},
"status": {
"type": "string"
},
"settings": {
"type": "array"
},
"user_photo": {
"type": "string"
}
},
"required": [
"id",
"external_id",
"first_name",
"last_name",
"username",
"professional_email",
"professional_mobile_phone",
"professional_phone",
"role",
"is_active",
"status",
"settings",
"user_photo"
],
"additionalProperties": false
},
"specific_psos": {
"type": "array"
},
"conditions": {
"type": "array"
},
"permissions": {
"type": "array"
}
},
"required": [
"id",
"name",
"description",
"alias",
"status",
"is_active",
"created_at",
"updated_at",
"specific_psos",
"conditions"
]
}
}
}
}401Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 401
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}403Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 403
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}404Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 404
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}406Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 406
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}422Headers
Content-Type: application/jsonBody
{
"message": "Descriptive error message",
"status_code": 422,
"errors": [
"Error message"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
},
"errors": {
"type": "array"
}
}
}500Headers
Content-Type: application/jsonBody
{
"message": "Internal Error",
"status_code": 500
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}ShowGET/groups/{id}/members
Fetch information about group members. Supports pagination
Example URI
- id
number(required) Example: 123ID of the Group item.
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>200Headers
Content-Type: application/jsonBody
{
"data": [
{
"id": 1,
"external_id": 1,
"first_name": "John",
"last_name": "Snow",
"username": "john_snow",
"professional_email": "jsnow@example.com",
"professional_mobile_phone": "00 33 1 40 00 00 00",
"professional_phone": "00 33 1 40 00 00 00",
"role": [
"bastard",
"king"
],
"is_active": true,
"status": "remote",
"settings": [
"[]"
],
"user_photo": "http://example.com/images/1.jpg"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"external_id": {
"type": "number"
},
"first_name": {
"type": "string"
},
"last_name": {
"type": "string"
},
"username": {
"type": "string"
},
"professional_email": {
"type": "string"
},
"professional_mobile_phone": {
"type": "string"
},
"professional_phone": {
"type": "string"
},
"role": {
"type": "array"
},
"is_active": {
"type": "boolean"
},
"status": {
"type": "string"
},
"settings": {
"type": "array"
},
"user_photo": {
"type": "string"
}
},
"required": [
"id",
"external_id",
"first_name",
"last_name",
"username",
"professional_email",
"professional_mobile_phone",
"professional_phone",
"role",
"is_active",
"status",
"settings",
"user_photo"
]
}
}
}
}401Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 401
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}403Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 403
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}404Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 404
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}406Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 406
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}422Headers
Content-Type: application/jsonBody
{
"message": "Descriptive error message",
"status_code": 422,
"errors": [
"Error message"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
},
"errors": {
"type": "array"
}
}
}500Headers
Content-Type: application/jsonBody
{
"message": "Internal Error",
"status_code": 500
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}CreatePOST/groups
Create new group item
Example URI
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>Body
{
"pso_type": "usr",
"owner": 5,
"name": {
"en": "Some text",
"fr": "Du texte",
"de": "Setwas Text",
"es": "Algún texto"
},
"description": {
"en": "Some text",
"fr": "Du texte",
"de": "Setwas Text",
"es": "Algún texto"
},
"alias": "usr_global",
"is_active": true,
"specific_psos": [
1
],
"conditions": [
{
"type": "group",
"combine_with": "and",
"conditions": [
{
"type": "condition",
"field": "usr_email",
"raw_value": "john.doe@example.com",
"field_value: usr_additional_email": "Hello, world!",
"operator": "Hello, world!"
}
]
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"pso_type": {
"type": "string"
},
"owner": {
"type": "number",
"description": "Id of PSO."
},
"name": {
"type": "object",
"properties": {
"en": {
"type": "string"
},
"fr": {
"type": "string"
},
"de": {
"type": "string"
},
"es": {
"type": "string"
}
},
"required": [
"en",
"fr",
"de",
"es"
]
},
"description": {
"type": "object",
"properties": {
"en": {
"type": "string"
},
"fr": {
"type": "string"
},
"de": {
"type": "string"
},
"es": {
"type": "string"
}
},
"required": [
"en",
"fr",
"de",
"es"
]
},
"alias": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"specific_psos": {
"type": "array"
},
"conditions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"group"
]
},
"combine_with": {
"type": "string",
"enum": [
"and",
"or"
]
},
"conditions": {
"type": "array"
}
},
"required": [
"type",
"combine_with",
"conditions"
]
}
}
},
"required": [
"pso_type",
"owner",
"name"
]
}201Headers
Content-Type: application/jsonBody
{
"data": {
"id": 123,
"alias": "can_be_null"
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"alias": {
"type": "string"
}
},
"required": [
"id"
],
"additionalProperties": false
}
}
}400Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 400
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}401Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 401
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}403Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 403
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}404Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 404
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}406Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 406
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}422Headers
Content-Type: application/jsonBody
{
"message": "Descriptive error message",
"status_code": 422,
"errors": [
"Error message"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
},
"errors": {
"type": "array"
}
}
}500Headers
Content-Type: application/jsonBody
{
"message": "Internal Error",
"status_code": 500
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}ShowGET/groups/{id}
Fetch single group item
Example URI
- id
number(required) Example: 123ID of the Group item.
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>200Headers
Content-Type: application/jsonBody
{
"data": {
"id": 32,
"name": "Group name",
"description": "...",
"alias": "usr_group",
"status": "ok",
"is_active": true,
"created_at": "2019-04-24 11:47:47",
"updated_at": "2019-04-24 11:47:47",
"processed_at": "2019-04-24 11:47:47",
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
},
"owner": {
"id": 1,
"external_id": 1,
"first_name": "John",
"last_name": "Snow",
"username": "john_snow",
"professional_email": "jsnow@example.com",
"professional_mobile_phone": "00 33 1 40 00 00 00",
"professional_phone": "00 33 1 40 00 00 00",
"role": [
"bastard",
"king"
],
"is_active": true,
"status": "remote",
"settings": [
"[]"
],
"user_photo": "http://example.com/images/1.jpg"
},
"specific_psos": [
{
"summary": {
"first_name": {
"id": 1,
"alias": "usr_first_name",
"value": "John"
},
"last_name": {
"id": 1,
"alias": "usr_first_name",
"value": "John"
},
"image": {
"id": 1,
"alias": "usr_first_name",
"value": "John"
},
"is_active": {
"id": 1,
"alias": "usr_first_name",
"value": "John"
},
"email": {
"id": 1,
"alias": "usr_first_name",
"value": "John"
},
"phone_number": ""
},
"pso": {
"id": 1,
"profile_form": {
"id": 1,
"name": "Profile Form",
"description": "Profile Form Description",
"is_active": true,
"active_field": "null"
},
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
},
"categories": [
{
"id": 1,
"name": "Category Name",
"alias": "category_alias"
}
],
"fields": {
"id": 1,
"name": "Field Name",
"position": 5,
"alias": "usr_first_name",
"has_unique_data": false,
"has_value": true,
"removable": false,
"is_active": true,
"list": false,
"read_only": false,
"required": true,
"type": {
"id": 1,
"name": "Data Type Name",
"alias": "data_type_alias",
"settings": [
{
"id": 1,
"name": "Data Type Setting Name",
"alias": "data_type_setting_alias",
"is_required": true
}
],
"supports_collection": false,
"supports_read_only": false,
"supports_unique": false
},
"category": {
"id": 32,
"alias": "usr_identity",
"position": 5,
"system_required": true,
"name": "Identity",
"description": "...",
"is_active": true,
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
}
},
"domains": [
{
"id": 46,
"alias": "usr_global",
"name": "User Global",
"description": "...",
"is_editable": false,
"is_removable": false,
"is_active": true,
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
}
}
],
"privacy_level": {
"id": 123,
"alias": "public",
"name": "Not Sensitive",
"level": 100
},
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
},
"items": [
{
"id": 1,
"name": "Field Name",
"position": 5,
"alias": "usr_first_name",
"has_unique_data": false,
"has_value": true,
"removable": false,
"is_active": true,
"list": false,
"read_only": false,
"required": true,
"type": {
"id": 1,
"name": "Data Type Name",
"alias": "data_type_alias",
"settings": [
{
"id": 1,
"name": "Data Type Setting Name",
"alias": "data_type_setting_alias",
"is_required": true
}
],
"supports_collection": false,
"supports_read_only": false,
"supports_unique": false
},
"category": {
"id": 32,
"alias": "usr_identity",
"position": 5,
"system_required": true,
"name": "Identity",
"description": "...",
"is_active": true,
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
}
},
"domains": [
{
"id": 46,
"alias": "usr_global",
"name": "User Global",
"description": "...",
"is_editable": false,
"is_removable": false,
"is_active": true,
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
}
}
],
"privacy_level": {
"id": 123,
"alias": "public",
"name": "Not Sensitive",
"level": 100
},
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
},
"items": [
{}
],
"options": [
{
"id": 198,
"name": "Chose me!",
"position": 9,
"value": "198",
"is_active": true
}
],
"settings": []
}
],
"options": [
{
"id": 198,
"name": "Chose me!",
"position": 9,
"value": "198",
"is_active": true
}
],
"settings": [],
"is_locked": false,
"value_details": [
"value1",
"value2"
],
"values_count": 2,
"assignment_settings": [
{
"setting": "public",
"value": "1"
}
],
"access_permissions": {
"history": true,
"view": true,
"edit": true
},
"assignment_permissions": {
"permissions": {
"id": 1,
"name": "View",
"alias": "view"
},
"access_list": [
"0",
"1",
"1"
]
}
}
}
}
],
"conditions": [
{
"type": "group",
"combine_with": "and",
"conditions": [
{
"type": "condition",
"field": "usr_email",
"raw_value": "john.doe@example.com",
"operator": "=="
}
]
}
],
"permissions": [
{
"can_edit": true,
"can_remove": true
}
]
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"alias": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"ok",
"pending"
]
},
"is_active": {
"type": "boolean"
},
"created_at": {
"type": "string"
},
"updated_at": {
"type": "string"
},
"processed_at": {
"type": "string"
},
"pso_type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"system_required": {
"type": "boolean"
},
"creation_form_instance_id": {
"type": "number"
},
"profile_form_instance_id": {
"type": "number"
}
},
"required": [
"id",
"name",
"alias",
"description",
"is_active",
"system_required",
"creation_form_instance_id",
"profile_form_instance_id"
],
"additionalProperties": false
},
"owner": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"external_id": {
"type": "number"
},
"first_name": {
"type": "string"
},
"last_name": {
"type": "string"
},
"username": {
"type": "string"
},
"professional_email": {
"type": "string"
},
"professional_mobile_phone": {
"type": "string"
},
"professional_phone": {
"type": "string"
},
"role": {
"type": "array"
},
"is_active": {
"type": "boolean"
},
"status": {
"type": "string"
},
"settings": {
"type": "array"
},
"user_photo": {
"type": "string"
}
},
"required": [
"id",
"external_id",
"first_name",
"last_name",
"username",
"professional_email",
"professional_mobile_phone",
"professional_phone",
"role",
"is_active",
"status",
"settings",
"user_photo"
],
"additionalProperties": false
},
"specific_psos": {
"type": "array"
},
"conditions": {
"type": "array"
},
"permissions": {
"type": "array"
}
},
"required": [
"id",
"name",
"description",
"alias",
"status",
"is_active",
"created_at",
"updated_at",
"specific_psos",
"conditions"
],
"additionalProperties": false
}
}
}401Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 401
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}403Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 403
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}404Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 404
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}406Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 406
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}422Headers
Content-Type: application/jsonBody
{
"message": "Descriptive error message",
"status_code": 422,
"errors": [
"Error message"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
},
"errors": {
"type": "array"
}
}
}500Headers
Content-Type: application/jsonBody
{
"message": "Internal Error",
"status_code": 500
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}DeleteDELETE/groups/{id}
Delete group item
Example URI
- id
number(required) Example: 123ID of the Group item.
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>204Headers
Content-Type: application/json401Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 401
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}403Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 403
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}404Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 404
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}406Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 406
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}422Headers
Content-Type: application/jsonBody
{
"message": "Descriptive error message",
"status_code": 422,
"errors": [
"Error message"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
},
"errors": {
"type": "array"
}
}
}500Headers
Content-Type: application/jsonBody
{
"message": "Internal Error",
"status_code": 500
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}UpdatePATCH/groups/{id}
Update group item
Example URI
- id
number(required) Example: 123ID of the Group item.
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>Body
{
"owner": 5,
"name": {
"en": "Some text",
"fr": "Du texte",
"de": "Setwas Text",
"es": "Algún texto"
},
"description": {
"en": "Some text",
"fr": "Du texte",
"de": "Setwas Text",
"es": "Algún texto"
},
"alias": "usr_global",
"is_active": true,
"is_editable": true,
"is_removable": true,
"specific_psos": [
1
],
"conditions": [
{
"type": "group",
"combine_with": "and",
"conditions": [
{
"type": "condition",
"field": "usr_email",
"raw_value": "john.doe@example.com",
"field_value: usr_additional_email": "Hello, world!",
"operator": "Hello, world!"
}
]
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"owner": {
"type": "number",
"description": "Id of PSO."
},
"name": {
"type": "object",
"properties": {
"en": {
"type": "string"
},
"fr": {
"type": "string"
},
"de": {
"type": "string"
},
"es": {
"type": "string"
}
},
"required": [
"en",
"fr",
"de",
"es"
]
},
"description": {
"type": "object",
"properties": {
"en": {
"type": "string"
},
"fr": {
"type": "string"
},
"de": {
"type": "string"
},
"es": {
"type": "string"
}
},
"required": [
"en",
"fr",
"de",
"es"
]
},
"alias": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"is_editable": {
"type": "boolean",
"description": "for admin only"
},
"is_removable": {
"type": "boolean",
"description": "for admin only"
},
"specific_psos": {
"type": "array"
},
"conditions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"group"
]
},
"combine_with": {
"type": "string",
"enum": [
"and",
"or"
]
},
"conditions": {
"type": "array"
}
},
"required": [
"type",
"combine_with",
"conditions"
]
}
}
}
}202Headers
Content-Type: application/json400Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 400
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}401Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 401
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}403Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 403
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}404Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 404
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}406Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 406
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}422Headers
Content-Type: application/jsonBody
{
"message": "Descriptive error message",
"status_code": 422,
"errors": [
"Error message"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
},
"errors": {
"type": "array"
}
}
}500Headers
Content-Type: application/jsonBody
{
"message": "Internal Error",
"status_code": 500
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}Ideas and comments ¶
Ideas and comments.
Ideas ¶
ListGET/ideas{?status-id,created-after,created-before,category-id,name,user,sort-by,sort-direction}
Fetch list of ideas
Example URI
- status-id
number(optional) Example: 123- created-after
date-time(optional) Example: 2019-03-21 09:34:58- created-before
date-time(optional) Example: 2019-03-21 09:34:58- category-id
number(optional) Example: 123- name
string(optional) Example: 'Some name'- user
string(optional) Example: 'JohnDoe'- sort-by
string(optional) Default: 'votes' Example: 'votes'Field to sort ideas by. Possible values:
votes,comments- sort-direction
string(optional) Default: 'desc' Example: 'desc'Direction to order results by. Possible values:
asc,desc
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>200Headers
Content-Type: application/jsonBody
{
"data": [
{
"id": 123,
"creator": {
"id": 1,
"external_id": 1,
"first_name": "John",
"last_name": "Snow",
"username": "john_snow",
"professional_email": "jsnow@example.com",
"professional_mobile_phone": "00 33 1 40 00 00 00",
"professional_phone": "00 33 1 40 00 00 00",
"role": [
"bastard",
"king"
],
"is_active": true,
"status": "remote",
"settings": [
"[]"
],
"user_photo": "http://example.com/images/1.jpg"
},
"moderator": {
"id": 1,
"external_id": 1,
"first_name": "John",
"last_name": "Snow",
"username": "john_snow",
"professional_email": "jsnow@example.com",
"professional_mobile_phone": "00 33 1 40 00 00 00",
"professional_phone": "00 33 1 40 00 00 00",
"role": [
"bastard",
"king"
],
"is_active": true,
"status": "remote",
"settings": [
"[]"
],
"user_photo": "http://example.com/images/1.jpg"
},
"status": {
"id": 123,
"name_key_id": 123,
"alias": "opened"
},
"category": {
"id": 32,
"alias": "usr_identity",
"position": 5,
"system_required": true,
"name": "Identity",
"description": "...",
"is_active": true,
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
}
},
"name": "Idea name",
"body": "Idea body",
"comments_count": 123,
"votes_count": 123,
"is_voted": true
}
],
"meta": {
"pagination": {
"total": 238,
"count": 25,
"per_page": 25,
"current_page": 2,
"total_pages": 10,
"links": {
"previous": "http://example.com/api/<endpoint>?page=1",
"next": "http://example.com/api/<endpoint>?page=3"
}
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"creator": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"external_id": {
"type": "number"
},
"first_name": {
"type": "string"
},
"last_name": {
"type": "string"
},
"username": {
"type": "string"
},
"professional_email": {
"type": "string"
},
"professional_mobile_phone": {
"type": "string"
},
"professional_phone": {
"type": "string"
},
"role": {
"type": "array"
},
"is_active": {
"type": "boolean"
},
"status": {
"type": "string"
},
"settings": {
"type": "array"
},
"user_photo": {
"type": "string"
}
},
"required": [
"id",
"external_id",
"first_name",
"last_name",
"username",
"professional_email",
"professional_mobile_phone",
"professional_phone",
"role",
"is_active",
"status",
"settings",
"user_photo"
],
"additionalProperties": false
},
"moderator": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"external_id": {
"type": "number"
},
"first_name": {
"type": "string"
},
"last_name": {
"type": "string"
},
"username": {
"type": "string"
},
"professional_email": {
"type": "string"
},
"professional_mobile_phone": {
"type": "string"
},
"professional_phone": {
"type": "string"
},
"role": {
"type": "array"
},
"is_active": {
"type": "boolean"
},
"status": {
"type": "string"
},
"settings": {
"type": "array"
},
"user_photo": {
"type": "string"
}
},
"required": [
"id",
"external_id",
"first_name",
"last_name",
"username",
"professional_email",
"professional_mobile_phone",
"professional_phone",
"role",
"is_active",
"status",
"settings",
"user_photo"
]
},
"status": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name_key_id": {
"type": "number"
},
"alias": {
"type": "string",
"enum": [
"opened",
"accepted",
"rejected",
"implemented",
"closed"
]
}
},
"required": [
"id",
"name_key_id",
"alias"
],
"additionalProperties": false
},
"category": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"alias": {
"type": "string"
},
"position": {
"type": "number"
},
"system_required": {
"type": "boolean"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"pso_type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"system_required": {
"type": "boolean"
},
"creation_form_instance_id": {
"type": "number"
},
"profile_form_instance_id": {
"type": "number"
}
},
"required": [
"id",
"name",
"alias",
"description",
"is_active",
"system_required",
"creation_form_instance_id",
"profile_form_instance_id"
],
"additionalProperties": false
}
},
"required": [
"id",
"alias",
"position",
"system_required",
"name",
"description",
"is_active"
],
"additionalProperties": false
},
"name": {
"type": "string"
},
"body": {
"type": [
"string",
"null"
]
},
"comments_count": {
"type": "number"
},
"votes_count": {
"type": "number"
},
"is_voted": {
"type": "boolean"
}
},
"required": [
"id",
"creator",
"status",
"category",
"name",
"comments_count",
"votes_count",
"is_voted"
]
}
},
"meta": {
"type": "object",
"properties": {
"pagination": {
"type": "object",
"properties": {
"total": {
"type": "number"
},
"count": {
"type": "number"
},
"per_page": {
"type": "number"
},
"current_page": {
"type": "number"
},
"total_pages": {
"type": "number"
},
"links": {
"type": "object",
"properties": {
"previous": {
"type": "string"
},
"next": {
"type": "string"
}
},
"required": [
"previous",
"next"
]
}
},
"required": [
"total",
"count",
"per_page",
"current_page",
"total_pages",
"links"
],
"additionalProperties": false
}
},
"required": [
"pagination"
]
}
}
}401Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 401
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}403Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 403
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}404Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 404
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}406Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 406
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}422Headers
Content-Type: application/jsonBody
{
"message": "Descriptive error message",
"status_code": 422,
"errors": [
"Error message"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
},
"errors": {
"type": "array"
}
}
}500Headers
Content-Type: application/jsonBody
{
"message": "Internal Error",
"status_code": 500
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}CreatePOST/ideas
Create Idea
Example URI
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: '*'Body
{
"name": "Idea name",
"body": "Idea body",
"creator_id": 1,
"category_id": 1
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"name": {
"type": "string"
},
"body": {
"type": "string"
},
"creator_id": {
"type": "number"
},
"category_id": {
"type": "number"
}
},
"required": [
"name",
"creator_id",
"category_id"
]
}201Headers
Content-Type: application/jsonBody
{
"data": {
"id": 123,
"creator": {
"id": 1,
"external_id": 1,
"first_name": "John",
"last_name": "Snow",
"username": "john_snow",
"professional_email": "jsnow@example.com",
"professional_mobile_phone": "00 33 1 40 00 00 00",
"professional_phone": "00 33 1 40 00 00 00",
"role": [
"bastard",
"king"
],
"is_active": true,
"status": "remote",
"settings": [
"[]"
],
"user_photo": "http://example.com/images/1.jpg"
},
"moderator": {
"id": 1,
"external_id": 1,
"first_name": "John",
"last_name": "Snow",
"username": "john_snow",
"professional_email": "jsnow@example.com",
"professional_mobile_phone": "00 33 1 40 00 00 00",
"professional_phone": "00 33 1 40 00 00 00",
"role": [
"bastard",
"king"
],
"is_active": true,
"status": "remote",
"settings": [
"[]"
],
"user_photo": "http://example.com/images/1.jpg"
},
"status": {
"id": 123,
"name_key_id": 123,
"alias": "opened"
},
"category": {
"id": 32,
"alias": "usr_identity",
"position": 5,
"system_required": true,
"name": "Identity",
"description": "...",
"is_active": true,
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
}
},
"name": "Idea name",
"body": "Idea body",
"comments_count": 123,
"votes_count": 123,
"is_voted": true
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"creator": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"external_id": {
"type": "number"
},
"first_name": {
"type": "string"
},
"last_name": {
"type": "string"
},
"username": {
"type": "string"
},
"professional_email": {
"type": "string"
},
"professional_mobile_phone": {
"type": "string"
},
"professional_phone": {
"type": "string"
},
"role": {
"type": "array"
},
"is_active": {
"type": "boolean"
},
"status": {
"type": "string"
},
"settings": {
"type": "array"
},
"user_photo": {
"type": "string"
}
},
"required": [
"id",
"external_id",
"first_name",
"last_name",
"username",
"professional_email",
"professional_mobile_phone",
"professional_phone",
"role",
"is_active",
"status",
"settings",
"user_photo"
],
"additionalProperties": false
},
"moderator": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"external_id": {
"type": "number"
},
"first_name": {
"type": "string"
},
"last_name": {
"type": "string"
},
"username": {
"type": "string"
},
"professional_email": {
"type": "string"
},
"professional_mobile_phone": {
"type": "string"
},
"professional_phone": {
"type": "string"
},
"role": {
"type": "array"
},
"is_active": {
"type": "boolean"
},
"status": {
"type": "string"
},
"settings": {
"type": "array"
},
"user_photo": {
"type": "string"
}
},
"required": [
"id",
"external_id",
"first_name",
"last_name",
"username",
"professional_email",
"professional_mobile_phone",
"professional_phone",
"role",
"is_active",
"status",
"settings",
"user_photo"
]
},
"status": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name_key_id": {
"type": "number"
},
"alias": {
"type": "string",
"enum": [
"opened",
"accepted",
"rejected",
"implemented",
"closed"
]
}
},
"required": [
"id",
"name_key_id",
"alias"
],
"additionalProperties": false
},
"category": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"alias": {
"type": "string"
},
"position": {
"type": "number"
},
"system_required": {
"type": "boolean"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"pso_type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"system_required": {
"type": "boolean"
},
"creation_form_instance_id": {
"type": "number"
},
"profile_form_instance_id": {
"type": "number"
}
},
"required": [
"id",
"name",
"alias",
"description",
"is_active",
"system_required",
"creation_form_instance_id",
"profile_form_instance_id"
],
"additionalProperties": false
}
},
"required": [
"id",
"alias",
"position",
"system_required",
"name",
"description",
"is_active"
],
"additionalProperties": false
},
"name": {
"type": "string"
},
"body": {
"type": [
"string",
"null"
]
},
"comments_count": {
"type": "number"
},
"votes_count": {
"type": "number"
},
"is_voted": {
"type": "boolean"
}
},
"required": [
"id",
"creator",
"status",
"category",
"name",
"comments_count",
"votes_count",
"is_voted"
],
"additionalProperties": false
}
}
}401Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 401
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}403Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 403
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}404Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 404
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}406Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 406
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}422Headers
Content-Type: application/jsonBody
{
"message": "Descriptive error message",
"status_code": 422,
"errors": [
"Error message"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
},
"errors": {
"type": "array"
}
}
}500Headers
Content-Type: application/jsonBody
{
"message": "Internal Error",
"status_code": 500
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}ShowGET/ideas/{id}
Fetch single Idea
Example URI
- id
number(required) Example: 123Id of the Idea.
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>200Headers
Content-Type: application/jsonBody
{
"data": {
"id": 123,
"creator": {
"id": 1,
"external_id": 1,
"first_name": "John",
"last_name": "Snow",
"username": "john_snow",
"professional_email": "jsnow@example.com",
"professional_mobile_phone": "00 33 1 40 00 00 00",
"professional_phone": "00 33 1 40 00 00 00",
"role": [
"bastard",
"king"
],
"is_active": true,
"status": "remote",
"settings": [
"[]"
],
"user_photo": "http://example.com/images/1.jpg"
},
"moderator": {
"id": 1,
"external_id": 1,
"first_name": "John",
"last_name": "Snow",
"username": "john_snow",
"professional_email": "jsnow@example.com",
"professional_mobile_phone": "00 33 1 40 00 00 00",
"professional_phone": "00 33 1 40 00 00 00",
"role": [
"bastard",
"king"
],
"is_active": true,
"status": "remote",
"settings": [
"[]"
],
"user_photo": "http://example.com/images/1.jpg"
},
"status": {
"id": 123,
"name_key_id": 123,
"alias": "opened"
},
"category": {
"id": 32,
"alias": "usr_identity",
"position": 5,
"system_required": true,
"name": "Identity",
"description": "...",
"is_active": true,
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
}
},
"name": "Idea name",
"body": "Idea body",
"comments_count": 123,
"votes_count": 123,
"is_voted": true
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"creator": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"external_id": {
"type": "number"
},
"first_name": {
"type": "string"
},
"last_name": {
"type": "string"
},
"username": {
"type": "string"
},
"professional_email": {
"type": "string"
},
"professional_mobile_phone": {
"type": "string"
},
"professional_phone": {
"type": "string"
},
"role": {
"type": "array"
},
"is_active": {
"type": "boolean"
},
"status": {
"type": "string"
},
"settings": {
"type": "array"
},
"user_photo": {
"type": "string"
}
},
"required": [
"id",
"external_id",
"first_name",
"last_name",
"username",
"professional_email",
"professional_mobile_phone",
"professional_phone",
"role",
"is_active",
"status",
"settings",
"user_photo"
],
"additionalProperties": false
},
"moderator": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"external_id": {
"type": "number"
},
"first_name": {
"type": "string"
},
"last_name": {
"type": "string"
},
"username": {
"type": "string"
},
"professional_email": {
"type": "string"
},
"professional_mobile_phone": {
"type": "string"
},
"professional_phone": {
"type": "string"
},
"role": {
"type": "array"
},
"is_active": {
"type": "boolean"
},
"status": {
"type": "string"
},
"settings": {
"type": "array"
},
"user_photo": {
"type": "string"
}
},
"required": [
"id",
"external_id",
"first_name",
"last_name",
"username",
"professional_email",
"professional_mobile_phone",
"professional_phone",
"role",
"is_active",
"status",
"settings",
"user_photo"
]
},
"status": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name_key_id": {
"type": "number"
},
"alias": {
"type": "string",
"enum": [
"opened",
"accepted",
"rejected",
"implemented",
"closed"
]
}
},
"required": [
"id",
"name_key_id",
"alias"
],
"additionalProperties": false
},
"category": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"alias": {
"type": "string"
},
"position": {
"type": "number"
},
"system_required": {
"type": "boolean"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"pso_type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"system_required": {
"type": "boolean"
},
"creation_form_instance_id": {
"type": "number"
},
"profile_form_instance_id": {
"type": "number"
}
},
"required": [
"id",
"name",
"alias",
"description",
"is_active",
"system_required",
"creation_form_instance_id",
"profile_form_instance_id"
],
"additionalProperties": false
}
},
"required": [
"id",
"alias",
"position",
"system_required",
"name",
"description",
"is_active"
],
"additionalProperties": false
},
"name": {
"type": "string"
},
"body": {
"type": [
"string",
"null"
]
},
"comments_count": {
"type": "number"
},
"votes_count": {
"type": "number"
},
"is_voted": {
"type": "boolean"
}
},
"required": [
"id",
"creator",
"status",
"category",
"name",
"comments_count",
"votes_count",
"is_voted"
],
"additionalProperties": false
}
}
}401Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 401
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}403Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 403
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}404Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 404
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}406Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 406
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}422Headers
Content-Type: application/jsonBody
{
"message": "Descriptive error message",
"status_code": 422,
"errors": [
"Error message"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
},
"errors": {
"type": "array"
}
}
}500Headers
Content-Type: application/jsonBody
{
"message": "Internal Error",
"status_code": 500
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}UpdatePATCH/ideas/{id}
Update Idea
Example URI
- id
number(required) Example: 123Id of the Idea.
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>Body
{
"name": "Idea name",
"body": "Idea body",
"status_id": 1,
"category_id": 1
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"name": {
"type": "string"
},
"body": {
"type": "string"
},
"status_id": {
"type": "number"
},
"category_id": {
"type": "number"
}
}
}202Headers
Content-Type: application/jsonBody
{
"data": {
"id": 123,
"creator": {
"id": 1,
"external_id": 1,
"first_name": "John",
"last_name": "Snow",
"username": "john_snow",
"professional_email": "jsnow@example.com",
"professional_mobile_phone": "00 33 1 40 00 00 00",
"professional_phone": "00 33 1 40 00 00 00",
"role": [
"bastard",
"king"
],
"is_active": true,
"status": "remote",
"settings": [
"[]"
],
"user_photo": "http://example.com/images/1.jpg"
},
"moderator": {
"id": 1,
"external_id": 1,
"first_name": "John",
"last_name": "Snow",
"username": "john_snow",
"professional_email": "jsnow@example.com",
"professional_mobile_phone": "00 33 1 40 00 00 00",
"professional_phone": "00 33 1 40 00 00 00",
"role": [
"bastard",
"king"
],
"is_active": true,
"status": "remote",
"settings": [
"[]"
],
"user_photo": "http://example.com/images/1.jpg"
},
"status": {
"id": 123,
"name_key_id": 123,
"alias": "opened"
},
"category": {
"id": 32,
"alias": "usr_identity",
"position": 5,
"system_required": true,
"name": "Identity",
"description": "...",
"is_active": true,
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
}
},
"name": "Idea name",
"body": "Idea body",
"comments_count": 123,
"votes_count": 123,
"is_voted": true
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"creator": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"external_id": {
"type": "number"
},
"first_name": {
"type": "string"
},
"last_name": {
"type": "string"
},
"username": {
"type": "string"
},
"professional_email": {
"type": "string"
},
"professional_mobile_phone": {
"type": "string"
},
"professional_phone": {
"type": "string"
},
"role": {
"type": "array"
},
"is_active": {
"type": "boolean"
},
"status": {
"type": "string"
},
"settings": {
"type": "array"
},
"user_photo": {
"type": "string"
}
},
"required": [
"id",
"external_id",
"first_name",
"last_name",
"username",
"professional_email",
"professional_mobile_phone",
"professional_phone",
"role",
"is_active",
"status",
"settings",
"user_photo"
],
"additionalProperties": false
},
"moderator": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"external_id": {
"type": "number"
},
"first_name": {
"type": "string"
},
"last_name": {
"type": "string"
},
"username": {
"type": "string"
},
"professional_email": {
"type": "string"
},
"professional_mobile_phone": {
"type": "string"
},
"professional_phone": {
"type": "string"
},
"role": {
"type": "array"
},
"is_active": {
"type": "boolean"
},
"status": {
"type": "string"
},
"settings": {
"type": "array"
},
"user_photo": {
"type": "string"
}
},
"required": [
"id",
"external_id",
"first_name",
"last_name",
"username",
"professional_email",
"professional_mobile_phone",
"professional_phone",
"role",
"is_active",
"status",
"settings",
"user_photo"
]
},
"status": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name_key_id": {
"type": "number"
},
"alias": {
"type": "string",
"enum": [
"opened",
"accepted",
"rejected",
"implemented",
"closed"
]
}
},
"required": [
"id",
"name_key_id",
"alias"
],
"additionalProperties": false
},
"category": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"alias": {
"type": "string"
},
"position": {
"type": "number"
},
"system_required": {
"type": "boolean"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"pso_type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"system_required": {
"type": "boolean"
},
"creation_form_instance_id": {
"type": "number"
},
"profile_form_instance_id": {
"type": "number"
}
},
"required": [
"id",
"name",
"alias",
"description",
"is_active",
"system_required",
"creation_form_instance_id",
"profile_form_instance_id"
],
"additionalProperties": false
}
},
"required": [
"id",
"alias",
"position",
"system_required",
"name",
"description",
"is_active"
],
"additionalProperties": false
},
"name": {
"type": "string"
},
"body": {
"type": [
"string",
"null"
]
},
"comments_count": {
"type": "number"
},
"votes_count": {
"type": "number"
},
"is_voted": {
"type": "boolean"
}
},
"required": [
"id",
"creator",
"status",
"category",
"name",
"comments_count",
"votes_count",
"is_voted"
],
"additionalProperties": false
}
}
}400Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 400
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}401Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 401
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}403Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 403
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}404Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 404
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}406Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 406
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}422Headers
Content-Type: application/jsonBody
{
"message": "Descriptive error message",
"status_code": 422,
"errors": [
"Error message"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
},
"errors": {
"type": "array"
}
}
}500Headers
Content-Type: application/jsonBody
{
"message": "Internal Error",
"status_code": 500
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}DeleteDELETE/ideas/{id}
Delete Idea
Example URI
- id
number(required) Example: 123Id of the Idea item.
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>204Headers
Content-Type: application/json401Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 401
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}403Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 403
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}404Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 404
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}406Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 406
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}422Headers
Content-Type: application/jsonBody
{
"message": "Descriptive error message",
"status_code": 422,
"errors": [
"Error message"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
},
"errors": {
"type": "array"
}
}
}500Headers
Content-Type: application/jsonBody
{
"message": "Internal Error",
"status_code": 500
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}LikePOST/ideas/{id}/like
Like Idea
Example URI
- id
number(required) Example: 123Id of the Idea.
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: '*'202Headers
Content-Type: application/json401Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 401
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}403Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 403
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}404Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 404
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}406Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 406
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}422Headers
Content-Type: application/jsonBody
{
"message": "Descriptive error message",
"status_code": 422,
"errors": [
"Error message"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
},
"errors": {
"type": "array"
}
}
}500Headers
Content-Type: application/jsonBody
{
"message": "Internal Error",
"status_code": 500
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}DislikePOST/ideas/{id}/dislike
Dislike Idea
Example URI
- id
number(required) Example: 123Id of the Idea.
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: '*'202Headers
Content-Type: application/json401Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 401
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}403Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 403
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}404Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 404
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}406Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 406
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}422Headers
Content-Type: application/jsonBody
{
"message": "Descriptive error message",
"status_code": 422,
"errors": [
"Error message"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
},
"errors": {
"type": "array"
}
}
}500Headers
Content-Type: application/jsonBody
{
"message": "Internal Error",
"status_code": 500
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}Get vote list (list of likes)GET/ideas/{id}/vote/list
Fetch list of Idea votes (likes).
Example URI
- id
number(required) Example: 123Id of the Idea.
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: '*'200Headers
Content-Type: application/json401Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 401
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}403Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 403
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}404Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 404
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}406Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 406
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}422Headers
Content-Type: application/jsonBody
{
"message": "Descriptive error message",
"status_code": 422,
"errors": [
"Error message"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
},
"errors": {
"type": "array"
}
}
}500Headers
Content-Type: application/jsonBody
{
"message": "Internal Error",
"status_code": 500
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}Comments ¶
ListGET/ideas/{idea}/comments
Fetch list of idea comments.
Example URI
- idea
number(required) Example: 123
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>200Headers
Content-Type: application/jsonBody
{
"data": [
{
"id": 123,
"creator": {
"id": 1,
"external_id": 1,
"first_name": "John",
"last_name": "Snow",
"username": "john_snow",
"professional_email": "jsnow@example.com",
"professional_mobile_phone": "00 33 1 40 00 00 00",
"professional_phone": "00 33 1 40 00 00 00",
"role": [
"bastard",
"king"
],
"is_active": true,
"status": "remote",
"settings": [
"[]"
],
"user_photo": "http://example.com/images/1.jpg"
},
"body": "Comment body text",
"idea_id": 234,
"created_at": "2019-01-01 23:34:40"
}
],
"meta": {
"pagination": {
"total": 238,
"count": 25,
"per_page": 25,
"current_page": 2,
"total_pages": 10,
"links": {
"previous": "http://example.com/api/<endpoint>?page=1",
"next": "http://example.com/api/<endpoint>?page=3"
}
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"creator": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"external_id": {
"type": "number"
},
"first_name": {
"type": "string"
},
"last_name": {
"type": "string"
},
"username": {
"type": "string"
},
"professional_email": {
"type": "string"
},
"professional_mobile_phone": {
"type": "string"
},
"professional_phone": {
"type": "string"
},
"role": {
"type": "array"
},
"is_active": {
"type": "boolean"
},
"status": {
"type": "string"
},
"settings": {
"type": "array"
},
"user_photo": {
"type": "string"
}
},
"required": [
"id",
"external_id",
"first_name",
"last_name",
"username",
"professional_email",
"professional_mobile_phone",
"professional_phone",
"role",
"is_active",
"status",
"settings",
"user_photo"
],
"additionalProperties": false
},
"body": {
"type": "string"
},
"idea_id": {
"type": "number"
},
"created_at": {
"type": "string"
}
},
"required": [
"id",
"creator",
"body",
"idea_id",
"created_at"
]
}
},
"meta": {
"type": "object",
"properties": {
"pagination": {
"type": "object",
"properties": {
"total": {
"type": "number"
},
"count": {
"type": "number"
},
"per_page": {
"type": "number"
},
"current_page": {
"type": "number"
},
"total_pages": {
"type": "number"
},
"links": {
"type": "object",
"properties": {
"previous": {
"type": "string"
},
"next": {
"type": "string"
}
},
"required": [
"previous",
"next"
]
}
},
"required": [
"total",
"count",
"per_page",
"current_page",
"total_pages",
"links"
],
"additionalProperties": false
}
},
"required": [
"pagination"
]
}
}
}401Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 401
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}403Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 403
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}404Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 404
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}406Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 406
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}422Headers
Content-Type: application/jsonBody
{
"message": "Descriptive error message",
"status_code": 422,
"errors": [
"Error message"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
},
"errors": {
"type": "array"
}
}
}500Headers
Content-Type: application/jsonBody
{
"message": "Internal Error",
"status_code": 500
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}ShowGET/ideas/{idea}/comments/{comment}
Fetch single Idea comment.
Example URI
- idea
number(required) Example: 123Id of the Idea.
- comment
number(required) Example: 234Id of Idea comment.
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>200Headers
Content-Type: application/jsonBody
{
"data": {
"id": 123,
"creator": {
"id": 1,
"external_id": 1,
"first_name": "John",
"last_name": "Snow",
"username": "john_snow",
"professional_email": "jsnow@example.com",
"professional_mobile_phone": "00 33 1 40 00 00 00",
"professional_phone": "00 33 1 40 00 00 00",
"role": [
"bastard",
"king"
],
"is_active": true,
"status": "remote",
"settings": [
"[]"
],
"user_photo": "http://example.com/images/1.jpg"
},
"body": "Comment body text",
"idea_id": 234,
"created_at": "2019-01-01 23:34:40"
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"creator": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"external_id": {
"type": "number"
},
"first_name": {
"type": "string"
},
"last_name": {
"type": "string"
},
"username": {
"type": "string"
},
"professional_email": {
"type": "string"
},
"professional_mobile_phone": {
"type": "string"
},
"professional_phone": {
"type": "string"
},
"role": {
"type": "array"
},
"is_active": {
"type": "boolean"
},
"status": {
"type": "string"
},
"settings": {
"type": "array"
},
"user_photo": {
"type": "string"
}
},
"required": [
"id",
"external_id",
"first_name",
"last_name",
"username",
"professional_email",
"professional_mobile_phone",
"professional_phone",
"role",
"is_active",
"status",
"settings",
"user_photo"
],
"additionalProperties": false
},
"body": {
"type": "string"
},
"idea_id": {
"type": "number"
},
"created_at": {
"type": "string"
}
},
"required": [
"id",
"creator",
"body",
"idea_id",
"created_at"
],
"additionalProperties": false
}
}
}401Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 401
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}403Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 403
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}404Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 404
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}406Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 406
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}422Headers
Content-Type: application/jsonBody
{
"message": "Descriptive error message",
"status_code": 422,
"errors": [
"Error message"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
},
"errors": {
"type": "array"
}
}
}500Headers
Content-Type: application/jsonBody
{
"message": "Internal Error",
"status_code": 500
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}CreatePOST/ideas/comments
Create Idea comment
Example URI
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: '*'Body
{
"body": "Idea body"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"body": {
"type": "string"
}
}
}201Headers
Content-Type: application/jsonBody
{
"data": {
"id": 123,
"creator": {
"id": 1,
"external_id": 1,
"first_name": "John",
"last_name": "Snow",
"username": "john_snow",
"professional_email": "jsnow@example.com",
"professional_mobile_phone": "00 33 1 40 00 00 00",
"professional_phone": "00 33 1 40 00 00 00",
"role": [
"bastard",
"king"
],
"is_active": true,
"status": "remote",
"settings": [
"[]"
],
"user_photo": "http://example.com/images/1.jpg"
},
"body": "Comment body text",
"idea_id": 234,
"created_at": "2019-01-01 23:34:40"
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"creator": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"external_id": {
"type": "number"
},
"first_name": {
"type": "string"
},
"last_name": {
"type": "string"
},
"username": {
"type": "string"
},
"professional_email": {
"type": "string"
},
"professional_mobile_phone": {
"type": "string"
},
"professional_phone": {
"type": "string"
},
"role": {
"type": "array"
},
"is_active": {
"type": "boolean"
},
"status": {
"type": "string"
},
"settings": {
"type": "array"
},
"user_photo": {
"type": "string"
}
},
"required": [
"id",
"external_id",
"first_name",
"last_name",
"username",
"professional_email",
"professional_mobile_phone",
"professional_phone",
"role",
"is_active",
"status",
"settings",
"user_photo"
],
"additionalProperties": false
},
"body": {
"type": "string"
},
"idea_id": {
"type": "number"
},
"created_at": {
"type": "string"
}
},
"required": [
"id",
"creator",
"body",
"idea_id",
"created_at"
],
"additionalProperties": false
}
}
}401Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 401
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}403Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 403
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}404Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 404
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}406Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 406
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}422Headers
Content-Type: application/jsonBody
{
"message": "Descriptive error message",
"status_code": 422,
"errors": [
"Error message"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
},
"errors": {
"type": "array"
}
}
}500Headers
Content-Type: application/jsonBody
{
"message": "Internal Error",
"status_code": 500
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}UpdatePATCH/ideas/{idea}/comments/{comment}
Update Idea comment.
Example URI
- idea
number(required) Example: 123Id of the Idea.
- comment
number(required) Example: 234Id of the Idea comment.
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>Body
{
"body": "Idea body"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"body": {
"type": "string"
}
}
}202Headers
Content-Type: application/jsonBody
{
"data": {
"id": 123,
"creator": {
"id": 1,
"external_id": 1,
"first_name": "John",
"last_name": "Snow",
"username": "john_snow",
"professional_email": "jsnow@example.com",
"professional_mobile_phone": "00 33 1 40 00 00 00",
"professional_phone": "00 33 1 40 00 00 00",
"role": [
"bastard",
"king"
],
"is_active": true,
"status": "remote",
"settings": [
"[]"
],
"user_photo": "http://example.com/images/1.jpg"
},
"body": "Comment body text",
"idea_id": 234,
"created_at": "2019-01-01 23:34:40"
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"creator": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"external_id": {
"type": "number"
},
"first_name": {
"type": "string"
},
"last_name": {
"type": "string"
},
"username": {
"type": "string"
},
"professional_email": {
"type": "string"
},
"professional_mobile_phone": {
"type": "string"
},
"professional_phone": {
"type": "string"
},
"role": {
"type": "array"
},
"is_active": {
"type": "boolean"
},
"status": {
"type": "string"
},
"settings": {
"type": "array"
},
"user_photo": {
"type": "string"
}
},
"required": [
"id",
"external_id",
"first_name",
"last_name",
"username",
"professional_email",
"professional_mobile_phone",
"professional_phone",
"role",
"is_active",
"status",
"settings",
"user_photo"
],
"additionalProperties": false
},
"body": {
"type": "string"
},
"idea_id": {
"type": "number"
},
"created_at": {
"type": "string"
}
},
"required": [
"id",
"creator",
"body",
"idea_id",
"created_at"
],
"additionalProperties": false
}
}
}400Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 400
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}401Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 401
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}403Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 403
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}404Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 404
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}406Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 406
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}422Headers
Content-Type: application/jsonBody
{
"message": "Descriptive error message",
"status_code": 422,
"errors": [
"Error message"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
},
"errors": {
"type": "array"
}
}
}500Headers
Content-Type: application/jsonBody
{
"message": "Internal Error",
"status_code": 500
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}DeleteDELETE/ideas/{idea}/comments/{comment}
Delete Idea comment.
Example URI
- idea
number(required) Example: 123Id of the Idea.
- comment
number(required) Example: 234Id of the Idea comment.
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>204Headers
Content-Type: application/json401Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 401
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}403Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 403
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}404Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 404
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}406Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 406
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}422Headers
Content-Type: application/jsonBody
{
"message": "Descriptive error message",
"status_code": 422,
"errors": [
"Error message"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
},
"errors": {
"type": "array"
}
}
}500Headers
Content-Type: application/jsonBody
{
"message": "Internal Error",
"status_code": 500
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}History ¶
History provide users with the list of answers changes
History ¶
Get HistoryGET/history/psos/{pso}/{field}
Get detailed changes of answers data for selected pso (user) and field
Example URI
- pso
number(required) Example: 1id of pso
- field
number(required) Example: 2id of field
Headers
Accept: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target permission>200Headers
Content-Type: application/jsonBody
{
"data": {
"name": "Field Name",
"field": 1,
"data_type": {
"id": 1,
"name": "Data Type Name",
"alias": "data_type_alias",
"settings": [
{
"id": 1,
"name": "Data Type Setting Name",
"alias": "data_type_setting_alias",
"is_required": true
}
],
"supports_collection": false,
"supports_read_only": false,
"supports_unique": false
},
"action_type": "updated",
"user": {
"summary": {
"first_name": {
"id": 1,
"alias": "usr_first_name",
"value": "John"
},
"last_name": {
"id": 1,
"alias": "usr_first_name",
"value": "John"
},
"image": {
"id": 1,
"alias": "usr_first_name",
"value": "John"
},
"is_active": {
"id": 1,
"alias": "usr_first_name",
"value": "John"
},
"email": {
"id": 1,
"alias": "usr_first_name",
"value": "John"
},
"phone_number": ""
},
"pso": {
"id": 1,
"profile_form": {
"id": 1,
"name": "Profile Form",
"description": "Profile Form Description",
"is_active": true,
"active_field": "null"
},
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
},
"categories": [
{
"id": 1,
"name": "Category Name",
"alias": "category_alias"
}
],
"fields": {
"id": 1,
"name": "Field Name",
"position": 5,
"alias": "usr_first_name",
"has_unique_data": false,
"has_value": true,
"removable": false,
"is_active": true,
"list": false,
"read_only": false,
"required": true,
"type": {
"id": 1,
"name": "Data Type Name",
"alias": "data_type_alias",
"settings": [
{
"id": 1,
"name": "Data Type Setting Name",
"alias": "data_type_setting_alias",
"is_required": true
}
],
"supports_collection": false,
"supports_read_only": false,
"supports_unique": false
},
"category": {
"id": 32,
"alias": "usr_identity",
"position": 5,
"system_required": true,
"name": "Identity",
"description": "...",
"is_active": true,
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
}
},
"domains": [
{
"id": 46,
"alias": "usr_global",
"name": "User Global",
"description": "...",
"is_editable": false,
"is_removable": false,
"is_active": true,
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
}
}
],
"privacy_level": {
"id": 123,
"alias": "public",
"name": "Not Sensitive",
"level": 100
},
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
},
"items": [
{
"id": 1,
"name": "Field Name",
"position": 5,
"alias": "usr_first_name",
"has_unique_data": false,
"has_value": true,
"removable": false,
"is_active": true,
"list": false,
"read_only": false,
"required": true,
"type": {
"id": 1,
"name": "Data Type Name",
"alias": "data_type_alias",
"settings": [
{
"id": 1,
"name": "Data Type Setting Name",
"alias": "data_type_setting_alias",
"is_required": true
}
],
"supports_collection": false,
"supports_read_only": false,
"supports_unique": false
},
"category": {
"id": 32,
"alias": "usr_identity",
"position": 5,
"system_required": true,
"name": "Identity",
"description": "...",
"is_active": true,
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
}
},
"domains": [
{
"id": 46,
"alias": "usr_global",
"name": "User Global",
"description": "...",
"is_editable": false,
"is_removable": false,
"is_active": true,
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
}
}
],
"privacy_level": {
"id": 123,
"alias": "public",
"name": "Not Sensitive",
"level": 100
},
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
},
"items": [
{}
],
"options": [
{
"id": 198,
"name": "Chose me!",
"position": 9,
"value": "198",
"is_active": true
}
],
"settings": []
}
],
"options": [
{
"id": 198,
"name": "Chose me!",
"position": 9,
"value": "198",
"is_active": true
}
],
"settings": [],
"is_locked": false,
"value_details": [
"value1",
"value2"
],
"values_count": 2,
"assignment_settings": [
{
"setting": "public",
"value": "1"
}
],
"access_permissions": {
"history": true,
"view": true,
"edit": true
},
"assignment_permissions": {
"permissions": {
"id": 1,
"name": "View",
"alias": "view"
},
"access_list": [
"0",
"1",
"1"
]
}
}
}
},
"value": "updated value",
"updated_at": "2019-01-01 23:34:40"
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"field": {
"type": "number"
},
"data_type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"settings": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"is_required": {
"type": "boolean"
}
},
"required": [
"id",
"name",
"alias",
"is_required"
]
}
},
"supports_collection": {
"type": "boolean"
},
"supports_read_only": {
"type": "boolean"
},
"supports_unique": {
"type": "boolean"
}
},
"required": [
"id",
"name",
"alias",
"supports_collection",
"supports_read_only",
"supports_unique"
]
},
"action_type": {
"type": "string"
},
"user": {
"type": "object",
"properties": {
"summary": {
"type": "object",
"properties": {
"first_name": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"alias": {
"type": "string"
},
"value": {
"type": "string",
"description": "if field support multiple values it can be array"
}
},
"required": [
"id",
"alias",
"value"
]
},
"last_name": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"alias": {
"type": "string"
},
"value": {
"type": "string",
"description": "if field support multiple values it can be array"
}
},
"required": [
"id",
"alias",
"value"
]
},
"image": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"alias": {
"type": "string"
},
"value": {
"type": "string",
"description": "if field support multiple values it can be array"
}
},
"required": [
"id",
"alias",
"value"
]
},
"is_active": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"alias": {
"type": "string"
},
"value": {
"type": "string",
"description": "if field support multiple values it can be array"
}
},
"required": [
"id",
"alias",
"value"
]
},
"email": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"alias": {
"type": "string"
},
"value": {
"type": "string",
"description": "if field support multiple values it can be array"
}
},
"required": [
"id",
"alias",
"value"
]
},
"phone_number": {
"type": "string"
}
},
"required": [
"first_name",
"last_name",
"image",
"is_active",
"email",
"phone_number"
]
},
"pso": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"profile_form": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"active_field": {
"type": [
"string",
"null"
]
}
},
"required": [
"id",
"name",
"description",
"is_active"
]
},
"pso_type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"system_required": {
"type": "boolean"
},
"creation_form_instance_id": {
"type": "number"
},
"profile_form_instance_id": {
"type": "number"
}
},
"required": [
"id",
"name",
"alias",
"description",
"is_active",
"system_required",
"creation_form_instance_id",
"profile_form_instance_id"
]
},
"categories": {
"type": "array"
},
"fields": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"position": {
"type": "number"
},
"alias": {
"type": "string"
},
"has_unique_data": {
"type": "boolean",
"description": "whether field requires values to be unique across system"
},
"has_value": {
"type": "boolean",
"description": "whether field has at least one value submitted"
},
"removable": {
"type": "boolean",
"description": "whether field can be removed from system"
},
"is_active": {
"type": "boolean"
},
"list": {
"type": "boolean",
"description": "whether field can handle collection of values"
},
"read_only": {
"type": "boolean",
"description": "whether field value can be changed"
},
"required": {
"type": "boolean",
"description": "whether field value required by system"
},
"type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"settings": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"is_required": {
"type": "boolean"
}
},
"required": [
"id",
"name",
"alias",
"is_required"
]
}
},
"supports_collection": {
"type": "boolean"
},
"supports_read_only": {
"type": "boolean"
},
"supports_unique": {
"type": "boolean"
}
},
"required": [
"id",
"name",
"alias",
"settings",
"supports_collection",
"supports_read_only",
"supports_unique"
],
"additionalProperties": false
},
"category": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"alias": {
"type": "string"
},
"position": {
"type": "number"
},
"system_required": {
"type": "boolean"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"pso_type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"system_required": {
"type": "boolean"
},
"creation_form_instance_id": {
"type": "number"
},
"profile_form_instance_id": {
"type": "number"
}
},
"required": [
"id",
"name",
"alias",
"description",
"is_active",
"system_required",
"creation_form_instance_id",
"profile_form_instance_id"
],
"additionalProperties": false
}
},
"required": [
"id",
"alias",
"position",
"system_required",
"name",
"description",
"is_active"
],
"additionalProperties": false
},
"domains": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"alias": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"is_editable": {
"type": "boolean"
},
"is_removable": {
"type": "boolean"
},
"is_active": {
"type": "boolean"
},
"pso_type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"system_required": {
"type": "boolean"
},
"creation_form_instance_id": {
"type": "number"
},
"profile_form_instance_id": {
"type": "number"
}
},
"required": [
"id",
"name",
"alias",
"description",
"is_active",
"system_required",
"creation_form_instance_id",
"profile_form_instance_id"
],
"additionalProperties": false
}
},
"required": [
"id",
"alias",
"name",
"description",
"is_editable",
"is_removable",
"is_active"
]
}
},
"privacy_level": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"alias": {
"type": "string"
},
"name": {
"type": "string"
},
"level": {
"type": "number"
}
},
"required": [
"id",
"alias",
"name",
"level"
],
"additionalProperties": false
},
"pso_type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"system_required": {
"type": "boolean"
},
"creation_form_instance_id": {
"type": "number"
},
"profile_form_instance_id": {
"type": "number"
}
},
"required": [
"id",
"name",
"alias",
"description",
"is_active",
"system_required",
"creation_form_instance_id",
"profile_form_instance_id"
],
"additionalProperties": false
},
"items": {
"type": [
"array",
"null"
],
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"position": {
"type": "number"
},
"alias": {
"type": "string"
},
"has_unique_data": {
"type": "boolean",
"description": "whether field requires values to be unique across system"
},
"has_value": {
"type": "boolean",
"description": "whether field has at least one value submitted"
},
"removable": {
"type": "boolean",
"description": "whether field can be removed from system"
},
"is_active": {
"type": "boolean"
},
"list": {
"type": "boolean",
"description": "whether field can handle collection of values"
},
"read_only": {
"type": "boolean",
"description": "whether field value can be changed"
},
"required": {
"type": "boolean",
"description": "whether field value required by system"
},
"type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"settings": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"is_required": {
"type": "boolean"
}
},
"required": [
"id",
"name",
"alias",
"is_required"
]
}
},
"supports_collection": {
"type": "boolean"
},
"supports_read_only": {
"type": "boolean"
},
"supports_unique": {
"type": "boolean"
}
},
"required": [
"id",
"name",
"alias",
"settings",
"supports_collection",
"supports_read_only",
"supports_unique"
],
"additionalProperties": false
},
"category": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"alias": {
"type": "string"
},
"position": {
"type": "number"
},
"system_required": {
"type": "boolean"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"pso_type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"system_required": {
"type": "boolean"
},
"creation_form_instance_id": {
"type": "number"
},
"profile_form_instance_id": {
"type": "number"
}
},
"required": [
"id",
"name",
"alias",
"description",
"is_active",
"system_required",
"creation_form_instance_id",
"profile_form_instance_id"
],
"additionalProperties": false
}
},
"required": [
"id",
"alias",
"position",
"system_required",
"name",
"description",
"is_active"
],
"additionalProperties": false
},
"domains": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"alias": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"is_editable": {
"type": "boolean"
},
"is_removable": {
"type": "boolean"
},
"is_active": {
"type": "boolean"
},
"pso_type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"system_required": {
"type": "boolean"
},
"creation_form_instance_id": {
"type": "number"
},
"profile_form_instance_id": {
"type": "number"
}
},
"required": [
"id",
"name",
"alias",
"description",
"is_active",
"system_required",
"creation_form_instance_id",
"profile_form_instance_id"
],
"additionalProperties": false
}
},
"required": [
"id",
"alias",
"name",
"description",
"is_editable",
"is_removable",
"is_active"
]
}
},
"privacy_level": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"alias": {
"type": "string"
},
"name": {
"type": "string"
},
"level": {
"type": "number"
}
},
"required": [
"id",
"alias",
"name",
"level"
],
"additionalProperties": false
},
"pso_type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"system_required": {
"type": "boolean"
},
"creation_form_instance_id": {
"type": "number"
},
"profile_form_instance_id": {
"type": "number"
}
},
"required": [
"id",
"name",
"alias",
"description",
"is_active",
"system_required",
"creation_form_instance_id",
"profile_form_instance_id"
],
"additionalProperties": false
},
"items": {
"type": [
"array",
"null"
],
"items": {
"type": "object",
"properties": {}
}
},
"options": {
"type": [
"array",
"null"
],
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"position": {
"type": "number"
},
"value": {
"type": "string"
},
"is_active": {
"type": "boolean"
}
},
"required": [
"id",
"name",
"position",
"value",
"is_active"
]
},
"description": "List of options with possible (allowed) values."
},
"settings": {
"type": "array",
"items": {
"type": "string"
},
"description": "Common field settings"
}
},
"required": [
"id",
"name",
"position",
"alias",
"has_unique_data",
"has_value",
"removable",
"is_active",
"list",
"read_only",
"required"
]
}
},
"options": {
"type": [
"array",
"null"
],
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"position": {
"type": "number"
},
"value": {
"type": "string"
},
"is_active": {
"type": "boolean"
}
},
"required": [
"id",
"name",
"position",
"value",
"is_active"
]
},
"description": "List of options with possible (allowed) values."
},
"settings": {
"type": "array",
"items": {
"type": "string"
},
"description": "Common field settings"
},
"is_locked": {
"type": "boolean"
},
"value_details": {
"type": "array"
},
"values_count": {
"type": "number"
},
"assignment_settings": {
"type": "array"
},
"access_permissions": {
"type": "object",
"properties": {
"history": {
"type": "boolean"
},
"view": {
"type": "boolean"
},
"edit": {
"type": "boolean"
}
},
"required": [
"history",
"view",
"edit"
]
},
"assignment_permissions": {
"type": "object",
"properties": {
"permissions": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
}
},
"required": [
"id",
"name",
"alias"
]
},
"access_list": {
"type": "array",
"description": "user, manager, hr"
}
},
"required": [
"permissions",
"access_list"
]
}
},
"required": [
"id",
"name",
"position",
"alias",
"has_unique_data",
"has_value",
"removable",
"is_active",
"list",
"read_only",
"required",
"is_locked",
"value_details",
"values_count",
"assignment_settings",
"access_permissions",
"assignment_permissions"
]
}
},
"required": [
"id"
]
}
},
"required": [
"summary",
"pso"
]
},
"value": {
"type": "string",
"description": "Items can be History Response as well - in case we have a deal for composite field"
},
"updated_at": {
"type": "string"
}
},
"required": [
"name",
"field",
"data_type",
"action_type",
"user",
"value",
"updated_at"
]
}
}
}401Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 401
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}403Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 403
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}404Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 404
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}406Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 406
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}422Headers
Content-Type: application/jsonBody
{
"message": "Descriptive error message",
"status_code": 422,
"errors": [
"Error message"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
},
"errors": {
"type": "array"
}
}
}500Headers
Content-Type: application/jsonBody
{
"message": "Internal Error",
"status_code": 500
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}Language ¶
Available languages and default language.
Language ¶
ListGET/languages
Fetch list of languages
Example URI
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>200Headers
Content-Type: application/jsonBody
{
"data": [
{
"id": 1,
"alias": "en",
"name": "English"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"alias": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"id",
"alias",
"name"
]
}
}
}
}401Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 401
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}403Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 403
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}404Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 404
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}406Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 406
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}422Headers
Content-Type: application/jsonBody
{
"message": "Descriptive error message",
"status_code": 422,
"errors": [
"Error message"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
},
"errors": {
"type": "array"
}
}
}500Headers
Content-Type: application/jsonBody
{
"message": "Internal Error",
"status_code": 500
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}ShowGET/languages/default
Get company language. System default language will return if company language not specified.
Example URI
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>200Headers
Content-Type: application/jsonBody
{
"data": {
"id": 1,
"alias": "en",
"name": "English"
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"alias": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"id",
"alias",
"name"
],
"additionalProperties": false
}
}
}401Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 401
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}403Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 403
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}404Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 404
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}406Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 406
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}422Headers
Content-Type: application/jsonBody
{
"message": "Descriptive error message",
"status_code": 422,
"errors": [
"Error message"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
},
"errors": {
"type": "array"
}
}
}500Headers
Content-Type: application/jsonBody
{
"message": "Internal Error",
"status_code": 500
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}Me ¶
Scope of end points which is provide info about logged user, his team, company and assignments.
Management Permissions:
hr_request.view.forms- allow to view user form assignments
Me ¶
ShowGET/me
Fetch information about current user
Example URI
Headers
Accept: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target permission>200Headers
Content-Type: application/jsonBody
{
"data": {
"summary": {
"first_name": {
"id": 1,
"alias": "usr_first_name",
"value": "John"
},
"last_name": {
"id": 1,
"alias": "usr_first_name",
"value": "John"
},
"image": {
"id": 1,
"alias": "usr_first_name",
"value": "John"
},
"is_active": {
"id": 1,
"alias": "usr_first_name",
"value": "John"
},
"email": {
"id": 1,
"alias": "usr_first_name",
"value": "John"
},
"phone_number": ""
},
"pso": {
"id": 1,
"profile_form": {
"id": 1,
"name": "Profile Form",
"description": "Profile Form Description",
"is_active": true,
"active_field": "null"
},
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
},
"categories": [
{
"id": 1,
"name": "Category Name",
"alias": "category_alias"
}
],
"fields": {
"id": 1,
"name": "Field Name",
"position": 5,
"alias": "usr_first_name",
"has_unique_data": false,
"has_value": true,
"removable": false,
"is_active": true,
"list": false,
"read_only": false,
"required": true,
"type": {
"id": 1,
"name": "Data Type Name",
"alias": "data_type_alias",
"settings": [
{
"id": 1,
"name": "Data Type Setting Name",
"alias": "data_type_setting_alias",
"is_required": true
}
],
"supports_collection": false,
"supports_read_only": false,
"supports_unique": false
},
"category": {
"id": 32,
"alias": "usr_identity",
"position": 5,
"system_required": true,
"name": "Identity",
"description": "...",
"is_active": true,
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
}
},
"domains": [
{
"id": 46,
"alias": "usr_global",
"name": "User Global",
"description": "...",
"is_editable": false,
"is_removable": false,
"is_active": true,
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
}
}
],
"privacy_level": {
"id": 123,
"alias": "public",
"name": "Not Sensitive",
"level": 100
},
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
},
"items": [
{
"id": 1,
"name": "Field Name",
"position": 5,
"alias": "usr_first_name",
"has_unique_data": false,
"has_value": true,
"removable": false,
"is_active": true,
"list": false,
"read_only": false,
"required": true,
"type": {
"id": 1,
"name": "Data Type Name",
"alias": "data_type_alias",
"settings": [
{
"id": 1,
"name": "Data Type Setting Name",
"alias": "data_type_setting_alias",
"is_required": true
}
],
"supports_collection": false,
"supports_read_only": false,
"supports_unique": false
},
"category": {
"id": 32,
"alias": "usr_identity",
"position": 5,
"system_required": true,
"name": "Identity",
"description": "...",
"is_active": true,
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
}
},
"domains": [
{
"id": 46,
"alias": "usr_global",
"name": "User Global",
"description": "...",
"is_editable": false,
"is_removable": false,
"is_active": true,
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
}
}
],
"privacy_level": {
"id": 123,
"alias": "public",
"name": "Not Sensitive",
"level": 100
},
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
},
"items": [
{}
],
"options": [
{
"id": 198,
"name": "Chose me!",
"position": 9,
"value": "198",
"is_active": true
}
],
"settings": []
}
],
"options": [
{
"id": 198,
"name": "Chose me!",
"position": 9,
"value": "198",
"is_active": true
}
],
"settings": [],
"is_locked": false,
"value_details": [
"value1",
"value2"
],
"values_count": 2,
"assignment_settings": [
{
"setting": "public",
"value": "1"
}
],
"access_permissions": {
"history": true,
"view": true,
"edit": true
},
"assignment_permissions": {
"permissions": {
"id": 1,
"name": "View",
"alias": "view"
},
"access_list": [
"0",
"1",
"1"
]
}
}
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"summary": {
"type": "object",
"properties": {
"first_name": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"alias": {
"type": "string"
},
"value": {
"type": "string",
"description": "if field support multiple values it can be array"
}
},
"required": [
"id",
"alias",
"value"
]
},
"last_name": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"alias": {
"type": "string"
},
"value": {
"type": "string",
"description": "if field support multiple values it can be array"
}
},
"required": [
"id",
"alias",
"value"
]
},
"image": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"alias": {
"type": "string"
},
"value": {
"type": "string",
"description": "if field support multiple values it can be array"
}
},
"required": [
"id",
"alias",
"value"
]
},
"is_active": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"alias": {
"type": "string"
},
"value": {
"type": "string",
"description": "if field support multiple values it can be array"
}
},
"required": [
"id",
"alias",
"value"
]
},
"email": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"alias": {
"type": "string"
},
"value": {
"type": "string",
"description": "if field support multiple values it can be array"
}
},
"required": [
"id",
"alias",
"value"
]
},
"phone_number": {
"type": "string"
}
},
"required": [
"first_name",
"last_name",
"image",
"is_active",
"email",
"phone_number"
]
},
"pso": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"profile_form": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"active_field": {
"type": [
"string",
"null"
]
}
},
"required": [
"id",
"name",
"description",
"is_active"
]
},
"pso_type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"system_required": {
"type": "boolean"
},
"creation_form_instance_id": {
"type": "number"
},
"profile_form_instance_id": {
"type": "number"
}
},
"required": [
"id",
"name",
"alias",
"description",
"is_active",
"system_required",
"creation_form_instance_id",
"profile_form_instance_id"
]
},
"categories": {
"type": "array"
},
"fields": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"position": {
"type": "number"
},
"alias": {
"type": "string"
},
"has_unique_data": {
"type": "boolean",
"description": "whether field requires values to be unique across system"
},
"has_value": {
"type": "boolean",
"description": "whether field has at least one value submitted"
},
"removable": {
"type": "boolean",
"description": "whether field can be removed from system"
},
"is_active": {
"type": "boolean"
},
"list": {
"type": "boolean",
"description": "whether field can handle collection of values"
},
"read_only": {
"type": "boolean",
"description": "whether field value can be changed"
},
"required": {
"type": "boolean",
"description": "whether field value required by system"
},
"type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"settings": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"is_required": {
"type": "boolean"
}
},
"required": [
"id",
"name",
"alias",
"is_required"
]
}
},
"supports_collection": {
"type": "boolean"
},
"supports_read_only": {
"type": "boolean"
},
"supports_unique": {
"type": "boolean"
}
},
"required": [
"id",
"name",
"alias",
"settings",
"supports_collection",
"supports_read_only",
"supports_unique"
],
"additionalProperties": false
},
"category": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"alias": {
"type": "string"
},
"position": {
"type": "number"
},
"system_required": {
"type": "boolean"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"pso_type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"system_required": {
"type": "boolean"
},
"creation_form_instance_id": {
"type": "number"
},
"profile_form_instance_id": {
"type": "number"
}
},
"required": [
"id",
"name",
"alias",
"description",
"is_active",
"system_required",
"creation_form_instance_id",
"profile_form_instance_id"
],
"additionalProperties": false
}
},
"required": [
"id",
"alias",
"position",
"system_required",
"name",
"description",
"is_active"
],
"additionalProperties": false
},
"domains": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"alias": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"is_editable": {
"type": "boolean"
},
"is_removable": {
"type": "boolean"
},
"is_active": {
"type": "boolean"
},
"pso_type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"system_required": {
"type": "boolean"
},
"creation_form_instance_id": {
"type": "number"
},
"profile_form_instance_id": {
"type": "number"
}
},
"required": [
"id",
"name",
"alias",
"description",
"is_active",
"system_required",
"creation_form_instance_id",
"profile_form_instance_id"
],
"additionalProperties": false
}
},
"required": [
"id",
"alias",
"name",
"description",
"is_editable",
"is_removable",
"is_active"
]
}
},
"privacy_level": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"alias": {
"type": "string"
},
"name": {
"type": "string"
},
"level": {
"type": "number"
}
},
"required": [
"id",
"alias",
"name",
"level"
],
"additionalProperties": false
},
"pso_type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"system_required": {
"type": "boolean"
},
"creation_form_instance_id": {
"type": "number"
},
"profile_form_instance_id": {
"type": "number"
}
},
"required": [
"id",
"name",
"alias",
"description",
"is_active",
"system_required",
"creation_form_instance_id",
"profile_form_instance_id"
],
"additionalProperties": false
},
"items": {
"type": [
"array",
"null"
],
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"position": {
"type": "number"
},
"alias": {
"type": "string"
},
"has_unique_data": {
"type": "boolean",
"description": "whether field requires values to be unique across system"
},
"has_value": {
"type": "boolean",
"description": "whether field has at least one value submitted"
},
"removable": {
"type": "boolean",
"description": "whether field can be removed from system"
},
"is_active": {
"type": "boolean"
},
"list": {
"type": "boolean",
"description": "whether field can handle collection of values"
},
"read_only": {
"type": "boolean",
"description": "whether field value can be changed"
},
"required": {
"type": "boolean",
"description": "whether field value required by system"
},
"type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"settings": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"is_required": {
"type": "boolean"
}
},
"required": [
"id",
"name",
"alias",
"is_required"
]
}
},
"supports_collection": {
"type": "boolean"
},
"supports_read_only": {
"type": "boolean"
},
"supports_unique": {
"type": "boolean"
}
},
"required": [
"id",
"name",
"alias",
"settings",
"supports_collection",
"supports_read_only",
"supports_unique"
],
"additionalProperties": false
},
"category": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"alias": {
"type": "string"
},
"position": {
"type": "number"
},
"system_required": {
"type": "boolean"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"pso_type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"system_required": {
"type": "boolean"
},
"creation_form_instance_id": {
"type": "number"
},
"profile_form_instance_id": {
"type": "number"
}
},
"required": [
"id",
"name",
"alias",
"description",
"is_active",
"system_required",
"creation_form_instance_id",
"profile_form_instance_id"
],
"additionalProperties": false
}
},
"required": [
"id",
"alias",
"position",
"system_required",
"name",
"description",
"is_active"
],
"additionalProperties": false
},
"domains": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"alias": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"is_editable": {
"type": "boolean"
},
"is_removable": {
"type": "boolean"
},
"is_active": {
"type": "boolean"
},
"pso_type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"system_required": {
"type": "boolean"
},
"creation_form_instance_id": {
"type": "number"
},
"profile_form_instance_id": {
"type": "number"
}
},
"required": [
"id",
"name",
"alias",
"description",
"is_active",
"system_required",
"creation_form_instance_id",
"profile_form_instance_id"
],
"additionalProperties": false
}
},
"required": [
"id",
"alias",
"name",
"description",
"is_editable",
"is_removable",
"is_active"
]
}
},
"privacy_level": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"alias": {
"type": "string"
},
"name": {
"type": "string"
},
"level": {
"type": "number"
}
},
"required": [
"id",
"alias",
"name",
"level"
],
"additionalProperties": false
},
"pso_type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"system_required": {
"type": "boolean"
},
"creation_form_instance_id": {
"type": "number"
},
"profile_form_instance_id": {
"type": "number"
}
},
"required": [
"id",
"name",
"alias",
"description",
"is_active",
"system_required",
"creation_form_instance_id",
"profile_form_instance_id"
],
"additionalProperties": false
},
"items": {
"type": [
"array",
"null"
],
"items": {
"type": "object",
"properties": {}
}
},
"options": {
"type": [
"array",
"null"
],
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"position": {
"type": "number"
},
"value": {
"type": "string"
},
"is_active": {
"type": "boolean"
}
},
"required": [
"id",
"name",
"position",
"value",
"is_active"
]
},
"description": "List of options with possible (allowed) values."
},
"settings": {
"type": "array",
"items": {
"type": "string"
},
"description": "Common field settings"
}
},
"required": [
"id",
"name",
"position",
"alias",
"has_unique_data",
"has_value",
"removable",
"is_active",
"list",
"read_only",
"required"
]
}
},
"options": {
"type": [
"array",
"null"
],
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"position": {
"type": "number"
},
"value": {
"type": "string"
},
"is_active": {
"type": "boolean"
}
},
"required": [
"id",
"name",
"position",
"value",
"is_active"
]
},
"description": "List of options with possible (allowed) values."
},
"settings": {
"type": "array",
"items": {
"type": "string"
},
"description": "Common field settings"
},
"is_locked": {
"type": "boolean"
},
"value_details": {
"type": "array"
},
"values_count": {
"type": "number"
},
"assignment_settings": {
"type": "array"
},
"access_permissions": {
"type": "object",
"properties": {
"history": {
"type": "boolean"
},
"view": {
"type": "boolean"
},
"edit": {
"type": "boolean"
}
},
"required": [
"history",
"view",
"edit"
]
},
"assignment_permissions": {
"type": "object",
"properties": {
"permissions": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
}
},
"required": [
"id",
"name",
"alias"
]
},
"access_list": {
"type": "array",
"description": "user, manager, hr"
}
},
"required": [
"permissions",
"access_list"
]
}
},
"required": [
"id",
"name",
"position",
"alias",
"has_unique_data",
"has_value",
"removable",
"is_active",
"list",
"read_only",
"required",
"is_locked",
"value_details",
"values_count",
"assignment_settings",
"access_permissions",
"assignment_permissions"
]
}
},
"required": [
"id"
]
}
},
"required": [
"summary",
"pso"
]
}
}
}401Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 401
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}403Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 403
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}404Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 404
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}406Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 406
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}422Headers
Content-Type: application/jsonBody
{
"message": "Descriptive error message",
"status_code": 422,
"errors": [
"Error message"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
},
"errors": {
"type": "array"
}
}
}500Headers
Content-Type: application/jsonBody
{
"message": "Internal Error",
"status_code": 500
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}TeamGET/me/team
Fetch team of current user
Example URI
Headers
Accept: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target permission>200Headers
Content-Type: application/jsonBody
{
"data": [
{
"id": 1,
"first_name": "John",
"last_name": "Snow",
"professional_email": "john.snow@email.com",
"role": "admin",
"is_active": true,
"status": "Hello, world!",
"user_photo": "https://rest-dev.monportailrh.com/storage/company/images/image.jpeg",
"modules": [
{
"id": 1,
"name": "Module name",
"alias": "mdl",
"app_url": {
"android": "http://android/app/url",
"ios": "http://ios/app/url"
},
"store_url": {
"android": "http://android/store/url",
"ios": "http://ios/store/url"
},
"web_url": "http://web/url",
"icon": "http://image.png",
"permissions": [
{
"access": true,
"synchronisation": true
}
]
}
],
"features": [
{
"id": 1,
"alias": "feature_alias",
"name": "Feature Name"
}
],
"internal_modules": [
"time_tracking"
]
}
],
"meta": {
"pagination": {
"total": 238,
"count": 25,
"per_page": 25,
"current_page": 2,
"total_pages": 10,
"links": {
"previous": "http://example.com/api/<endpoint>?page=1",
"next": "http://example.com/api/<endpoint>?page=3"
}
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"first_name": {
"type": "string"
},
"last_name": {
"type": "string"
},
"professional_email": {
"type": "string"
},
"role": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"status": {
"type": "string"
},
"user_photo": {
"type": "string"
},
"modules": {
"type": "array"
},
"features": {
"type": "array"
},
"internal_modules": {
"type": "array"
}
},
"required": [
"id",
"first_name",
"last_name",
"professional_email",
"role",
"is_active",
"status",
"user_photo"
]
}
},
"meta": {
"type": "object",
"properties": {
"pagination": {
"type": "object",
"properties": {
"total": {
"type": "number"
},
"count": {
"type": "number"
},
"per_page": {
"type": "number"
},
"current_page": {
"type": "number"
},
"total_pages": {
"type": "number"
},
"links": {
"type": "object",
"properties": {
"previous": {
"type": "string"
},
"next": {
"type": "string"
}
},
"required": [
"previous",
"next"
]
}
},
"required": [
"total",
"count",
"per_page",
"current_page",
"total_pages",
"links"
],
"additionalProperties": false
}
},
"required": [
"pagination"
]
}
}
}401Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 401
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}403Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 403
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}404Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 404
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}406Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 406
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}422Headers
Content-Type: application/jsonBody
{
"message": "Descriptive error message",
"status_code": 422,
"errors": [
"Error message"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
},
"errors": {
"type": "array"
}
}
}500Headers
Content-Type: application/jsonBody
{
"message": "Internal Error",
"status_code": 500
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}Form InstancesGET/me/form-instances/{type}
Fetch List of form-instances by type (poll | permanent | unique | periodic)
Example URI
- type
string(required) Example: polltype of form instances
Headers
Accept: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target permission>200Headers
Content-Type: application/jsonBody
{
"data": [
{
"id": 1,
"name": "Form assignment name",
"description": "Form assignment description",
"is_active": true,
"fields": {
"id": 1,
"name": "Field Name",
"position": 5,
"alias": "usr_first_name",
"has_unique_data": false,
"has_value": true,
"removable": false,
"is_active": true,
"list": false,
"read_only": false,
"required": true,
"type": {
"id": 1,
"name": "Data Type Name",
"alias": "data_type_alias",
"settings": [
{
"id": 1,
"name": "Data Type Setting Name",
"alias": "data_type_setting_alias",
"is_required": true
}
],
"supports_collection": false,
"supports_read_only": false,
"supports_unique": false
},
"category": {
"id": 32,
"alias": "usr_identity",
"position": 5,
"system_required": true,
"name": "Identity",
"description": "...",
"is_active": true,
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
}
},
"domains": [
{
"id": 46,
"alias": "usr_global",
"name": "User Global",
"description": "...",
"is_editable": false,
"is_removable": false,
"is_active": true,
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
}
}
],
"privacy_level": {
"id": 123,
"alias": "public",
"name": "Not Sensitive",
"level": 100
},
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
},
"items": [
{
"id": 1,
"name": "Field Name",
"position": 5,
"alias": "usr_first_name",
"has_unique_data": false,
"has_value": true,
"removable": false,
"is_active": true,
"list": false,
"read_only": false,
"required": true,
"type": {
"id": 1,
"name": "Data Type Name",
"alias": "data_type_alias",
"settings": [
{
"id": 1,
"name": "Data Type Setting Name",
"alias": "data_type_setting_alias",
"is_required": true
}
],
"supports_collection": false,
"supports_read_only": false,
"supports_unique": false
},
"category": {
"id": 32,
"alias": "usr_identity",
"position": 5,
"system_required": true,
"name": "Identity",
"description": "...",
"is_active": true,
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
}
},
"domains": [
{
"id": 46,
"alias": "usr_global",
"name": "User Global",
"description": "...",
"is_editable": false,
"is_removable": false,
"is_active": true,
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
}
}
],
"privacy_level": {
"id": 123,
"alias": "public",
"name": "Not Sensitive",
"level": 100
},
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
},
"items": [
{}
],
"options": [
{
"id": 198,
"name": "Chose me!",
"position": 9,
"value": "198",
"is_active": true
}
],
"settings": []
}
],
"options": [
{
"id": 198,
"name": "Chose me!",
"position": 9,
"value": "198",
"is_active": true
}
],
"settings": [],
"is_locked": false,
"value_details": [
"value1",
"value2"
],
"values_count": 2,
"assignment_settings": [
{
"setting": "public",
"value": "1"
}
],
"access_permissions": {
"history": true,
"view": true,
"edit": true
},
"assignment_permissions": {
"permissions": {
"id": 1,
"name": "View",
"alias": "view"
},
"access_list": [
"0",
"1",
"1"
]
}
}
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "array"
}
}
}401Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 401
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}403Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 403
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}404Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 404
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}406Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 406
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}422Headers
Content-Type: application/jsonBody
{
"message": "Descriptive error message",
"status_code": 422,
"errors": [
"Error message"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
},
"errors": {
"type": "array"
}
}
}500Headers
Content-Type: application/jsonBody
{
"message": "Internal Error",
"status_code": 500
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}Form InstancesGET/me/poll
Fetch latest poll available to current user
Example URI
Headers
Accept: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target permission>200Headers
Content-Type: application/jsonBody
{
"data": [
{
"id": 1,
"name": "Form assignment name",
"description": "Form assignment description",
"is_active": true,
"fields": {
"id": 1,
"name": "Field Name",
"position": 5,
"alias": "usr_first_name",
"has_unique_data": false,
"has_value": true,
"removable": false,
"is_active": true,
"list": false,
"read_only": false,
"required": true,
"type": {
"id": 1,
"name": "Data Type Name",
"alias": "data_type_alias",
"settings": [
{
"id": 1,
"name": "Data Type Setting Name",
"alias": "data_type_setting_alias",
"is_required": true
}
],
"supports_collection": false,
"supports_read_only": false,
"supports_unique": false
},
"category": {
"id": 32,
"alias": "usr_identity",
"position": 5,
"system_required": true,
"name": "Identity",
"description": "...",
"is_active": true,
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
}
},
"domains": [
{
"id": 46,
"alias": "usr_global",
"name": "User Global",
"description": "...",
"is_editable": false,
"is_removable": false,
"is_active": true,
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
}
}
],
"privacy_level": {
"id": 123,
"alias": "public",
"name": "Not Sensitive",
"level": 100
},
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
},
"items": [
{
"id": 1,
"name": "Field Name",
"position": 5,
"alias": "usr_first_name",
"has_unique_data": false,
"has_value": true,
"removable": false,
"is_active": true,
"list": false,
"read_only": false,
"required": true,
"type": {
"id": 1,
"name": "Data Type Name",
"alias": "data_type_alias",
"settings": [
{
"id": 1,
"name": "Data Type Setting Name",
"alias": "data_type_setting_alias",
"is_required": true
}
],
"supports_collection": false,
"supports_read_only": false,
"supports_unique": false
},
"category": {
"id": 32,
"alias": "usr_identity",
"position": 5,
"system_required": true,
"name": "Identity",
"description": "...",
"is_active": true,
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
}
},
"domains": [
{
"id": 46,
"alias": "usr_global",
"name": "User Global",
"description": "...",
"is_editable": false,
"is_removable": false,
"is_active": true,
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
}
}
],
"privacy_level": {
"id": 123,
"alias": "public",
"name": "Not Sensitive",
"level": 100
},
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
},
"items": [
{}
],
"options": [
{
"id": 198,
"name": "Chose me!",
"position": 9,
"value": "198",
"is_active": true
}
],
"settings": []
}
],
"options": [
{
"id": 198,
"name": "Chose me!",
"position": 9,
"value": "198",
"is_active": true
}
],
"settings": [],
"is_locked": false,
"value_details": [
"value1",
"value2"
],
"values_count": 2,
"assignment_settings": [
{
"setting": "public",
"value": "1"
}
],
"access_permissions": {
"history": true,
"view": true,
"edit": true
},
"assignment_permissions": {
"permissions": {
"id": 1,
"name": "View",
"alias": "view"
},
"access_list": [
"0",
"1",
"1"
]
}
}
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "array"
}
}
}401Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 401
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}403Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 403
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}404Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 404
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}406Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 406
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}422Headers
Content-Type: application/jsonBody
{
"message": "Descriptive error message",
"status_code": 422,
"errors": [
"Error message"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
},
"errors": {
"type": "array"
}
}
}500Headers
Content-Type: application/jsonBody
{
"message": "Internal Error",
"status_code": 500
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}Time Tracking ¶
Stopwatch-like timer to track work time for employees
Time Tracking ¶
StatusPOST/time-tracking/status
Get actual state of the tracker. It returns last known event and total duration (in minutes) for the tracker
Example URI
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target features>200Headers
Content-Type: application/jsonBody
{
"data": {
"duration": 123,
"last_event": {
"date": "2019-04-24 11:47:47",
"event": "start",
"declared_location": {
"name": "United States of America ,Pueblo",
"coordinates": {
"lat": 30.312562,
"long": 59.873794
}
},
"reported_location": {
"name": "United States of America ,Pueblo",
"coordinates": {
"lat": 30.312562,
"long": 59.873794
}
},
"in_tolerance_radius": true
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"duration": {
"type": "number",
"description": "Total time duration for the tracker (in minutes) "
},
"last_event": {
"type": "object",
"properties": {
"date": {
"type": "string"
},
"event": {
"type": "string",
"enum": [
"start",
"stop",
"pause",
"resume"
]
},
"declared_location": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"coordinates": {
"type": "object",
"properties": {
"lat": {
"type": "number"
},
"long": {
"type": "number"
}
},
"required": [
"lat",
"long"
]
}
},
"required": [
"name"
],
"description": "Location specified by User"
},
"reported_location": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"coordinates": {
"type": "object",
"properties": {
"lat": {
"type": "number"
},
"long": {
"type": "number"
}
},
"required": [
"lat",
"long"
]
}
},
"required": [
"name"
],
"description": "Real location captured by GPS "
},
"in_tolerance_radius": {
"type": "boolean"
}
},
"required": [
"date",
"event",
"declared_location",
"reported_location",
"in_tolerance_radius"
]
}
},
"required": [
"duration",
"last_event"
],
"additionalProperties": false
}
}
}400Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 400
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}401Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 401
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}403Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 403
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}404Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 404
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}406Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 406
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}422Headers
Content-Type: application/jsonBody
{
"message": "Descriptive error message",
"status_code": 422,
"errors": [
"Error message"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
},
"errors": {
"type": "array"
}
}
}500Headers
Content-Type: application/jsonBody
{
"message": "Internal Error",
"status_code": 500
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}Start / Stop / Pause / ResumePOST/time-tracking/events
Add new event to manage state of tracker
Example URI
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target features>Body
{
"event": "start",
"declared_location": 1,
"reported_location": {
"name": "United States of America ,Pueblo",
"coordinates": {
"lat": 30.312562,
"long": 59.873794
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"event": {
"type": "string",
"enum": [
"start",
"stop",
"pause",
"resume"
]
},
"declared_location": {
"type": "number",
"description": "ID of Location PSO that user specified as his current place "
},
"reported_location": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"coordinates": {
"type": "object",
"properties": {
"lat": {
"type": "number"
},
"long": {
"type": "number"
}
},
"required": [
"lat",
"long"
]
}
},
"required": [
"name"
],
"description": "Real location object captured with help of GPS"
}
},
"required": [
"event",
"declared_location",
"reported_location"
]
}201Headers
Content-Type: application/jsonBody
{
"data": {
"duration": 123,
"last_event": {
"date": "2019-04-24 11:47:47",
"event": "start",
"declared_location": {
"name": "United States of America ,Pueblo",
"coordinates": {
"lat": 30.312562,
"long": 59.873794
}
},
"reported_location": {
"name": "United States of America ,Pueblo",
"coordinates": {
"lat": 30.312562,
"long": 59.873794
}
},
"in_tolerance_radius": true
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"duration": {
"type": "number",
"description": "Total time duration for the tracker (in minutes) "
},
"last_event": {
"type": "object",
"properties": {
"date": {
"type": "string"
},
"event": {
"type": "string",
"enum": [
"start",
"stop",
"pause",
"resume"
]
},
"declared_location": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"coordinates": {
"type": "object",
"properties": {
"lat": {
"type": "number"
},
"long": {
"type": "number"
}
},
"required": [
"lat",
"long"
]
}
},
"required": [
"name"
],
"description": "Location specified by User"
},
"reported_location": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"coordinates": {
"type": "object",
"properties": {
"lat": {
"type": "number"
},
"long": {
"type": "number"
}
},
"required": [
"lat",
"long"
]
}
},
"required": [
"name"
],
"description": "Real location captured by GPS "
},
"in_tolerance_radius": {
"type": "boolean"
}
},
"required": [
"date",
"event",
"declared_location",
"reported_location",
"in_tolerance_radius"
]
}
},
"required": [
"duration",
"last_event"
],
"additionalProperties": false
}
}
}400Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 400
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}401Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 401
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}403Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 403
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}404Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 404
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}406Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 406
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}422Headers
Content-Type: application/jsonBody
{
"message": "Descriptive error message",
"status_code": 422,
"errors": [
"Error message"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
},
"errors": {
"type": "array"
}
}
}500Headers
Content-Type: application/jsonBody
{
"message": "Internal Error",
"status_code": 500
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}ReportsGET/time-tracking/reports{?name,sort-by,sort-direction}
Show list of users that has access to Time Tracking in case to see Event History for them
Example URI
- name
string(optional) Example: JohnPart of of a name to search users by
- sort-by
string(optional) Example: emailField to sort Users by. Possible values:
email,name- sort-direction
string(optional) Example: ascDirection to order results by. Possible values:
asc,desc
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>200Headers
Content-Type: application/jsonBody
{
"data": {
"id": 1,
"external_id": 1,
"first_name": "John",
"last_name": "Snow",
"username": "john_snow",
"professional_email": "jsnow@example.com",
"professional_mobile_phone": "00 33 1 40 00 00 00",
"professional_phone": "00 33 1 40 00 00 00",
"role": [
"bastard",
"king"
],
"is_active": true,
"status": "remote",
"settings": [
"[]"
],
"user_photo": "http://example.com/images/1.jpg"
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"external_id": {
"type": "number"
},
"first_name": {
"type": "string"
},
"last_name": {
"type": "string"
},
"username": {
"type": "string"
},
"professional_email": {
"type": "string"
},
"professional_mobile_phone": {
"type": "string"
},
"professional_phone": {
"type": "string"
},
"role": {
"type": "array"
},
"is_active": {
"type": "boolean"
},
"status": {
"type": "string"
},
"settings": {
"type": "array"
},
"user_photo": {
"type": "string"
}
},
"required": [
"id",
"external_id",
"first_name",
"last_name",
"username",
"professional_email",
"professional_mobile_phone",
"professional_phone",
"role",
"is_active",
"status",
"settings",
"user_photo"
],
"additionalProperties": false
}
}
}401Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 401
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}403Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 403
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}404Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 404
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}406Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 406
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}422Headers
Content-Type: application/jsonBody
{
"message": "Descriptive error message",
"status_code": 422,
"errors": [
"Error message"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
},
"errors": {
"type": "array"
}
}
}500Headers
Content-Type: application/jsonBody
{
"message": "Internal Error",
"status_code": 500
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}Event HistoryGET/time-tracking/events{?user-id,sort-by,sort-direction}
Fetch time tracking events
Example URI
- user-id
integer(optional) Example: 123Filter events by User.
- sort-by
string(optional) Default: date Example: dateField to sort events by. Possible values:
date,event,declared_location.name,reported_location.name- sort-direction
string(optional) Default: desc Example: ascDirection to order results by. Possible values:
asc,desc
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>200Headers
Content-Type: application/jsonBody
{
"data": [
{
"date": "2019-04-24 11:47:47",
"event": "start",
"declared_location": {
"name": "United States of America ,Pueblo",
"coordinates": {
"lat": 30.312562,
"long": 59.873794
}
},
"reported_location": {
"name": "United States of America ,Pueblo",
"coordinates": {
"lat": 30.312562,
"long": 59.873794
}
},
"in_tolerance_radius": true
}
],
"meta": {
"pagination": {
"total": 238,
"count": 25,
"per_page": 25,
"current_page": 2,
"total_pages": 10,
"links": {
"previous": "http://example.com/api/<endpoint>?page=1",
"next": "http://example.com/api/<endpoint>?page=3"
}
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"date": {
"type": "string"
},
"event": {
"type": "string",
"enum": [
"start",
"stop",
"pause",
"resume"
]
},
"declared_location": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"coordinates": {
"type": "object",
"properties": {
"lat": {
"type": "number"
},
"long": {
"type": "number"
}
},
"required": [
"lat",
"long"
]
}
},
"required": [
"name"
],
"description": "Location specified by User"
},
"reported_location": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"coordinates": {
"type": "object",
"properties": {
"lat": {
"type": "number"
},
"long": {
"type": "number"
}
},
"required": [
"lat",
"long"
]
}
},
"required": [
"name"
],
"description": "Real location captured by GPS "
},
"in_tolerance_radius": {
"type": "boolean"
}
},
"required": [
"date",
"event",
"declared_location",
"reported_location",
"in_tolerance_radius"
]
}
},
"meta": {
"type": "object",
"properties": {
"pagination": {
"type": "object",
"properties": {
"total": {
"type": "number"
},
"count": {
"type": "number"
},
"per_page": {
"type": "number"
},
"current_page": {
"type": "number"
},
"total_pages": {
"type": "number"
},
"links": {
"type": "object",
"properties": {
"previous": {
"type": "string"
},
"next": {
"type": "string"
}
},
"required": [
"previous",
"next"
]
}
},
"required": [
"total",
"count",
"per_page",
"current_page",
"total_pages",
"links"
],
"additionalProperties": false
}
},
"required": [
"pagination"
]
}
}
}401Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 401
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}403Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 403
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}404Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 404
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}406Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 406
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}422Headers
Content-Type: application/jsonBody
{
"message": "Descriptive error message",
"status_code": 422,
"errors": [
"Error message"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
},
"errors": {
"type": "array"
}
}
}500Headers
Content-Type: application/jsonBody
{
"message": "Internal Error",
"status_code": 500
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}News ¶
News articles. Can be presented in 2 ways:
-
Standard news (has title, body, author and timestamps)
-
Top News (in addition to common parameters has )
News ¶
ListGET/news{?title,published-only,sort,order}
Fetch list of news
Example URI
- published-only
boolean(optional) Example: Filter by stateGet only published News. Filtering use publish-date attribute.
- title
string(optional) Example: News to searchSearch by new title. Non strict, case-insensitive.
- sort
publish-date, title(optional) Default: publish-date Example: titleField to sort news by.
- order
asc, desc(optional) Default: desc Example: ascDirection to order news by.
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>200Headers
Content-Type: application/jsonBody
{
"data": [
{
"id": 1,
"creator": {
"id": 1,
"external_id": 1,
"first_name": "John",
"last_name": "Snow",
"username": "john_snow",
"professional_email": "jsnow@example.com",
"professional_mobile_phone": "00 33 1 40 00 00 00",
"professional_phone": "00 33 1 40 00 00 00",
"role": [
"bastard",
"king"
],
"is_active": true,
"status": "remote",
"settings": [
"[]"
],
"user_photo": "http://example.com/images/1.jpg"
},
"type_id": 0,
"title": "News title",
"body": "Some text",
"button_text": "Click Me",
"logo": "http://example.com/images/logo.jpg",
"banner": "http://example.com/images/banner.jpg",
"external_link": "http://example.com/news/article-1.html",
"is_promote_as_top": true,
"publish_at": "2019-04-24 11:47:47",
"editable": true
}
],
"meta": {
"pagination": {
"total": 238,
"count": 25,
"per_page": 25,
"current_page": 2,
"total_pages": 10,
"links": {
"previous": "http://example.com/api/<endpoint>?page=1",
"next": "http://example.com/api/<endpoint>?page=3"
}
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"creator": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"external_id": {
"type": "number"
},
"first_name": {
"type": "string"
},
"last_name": {
"type": "string"
},
"username": {
"type": "string"
},
"professional_email": {
"type": "string"
},
"professional_mobile_phone": {
"type": "string"
},
"professional_phone": {
"type": "string"
},
"role": {
"type": "array"
},
"is_active": {
"type": "boolean"
},
"status": {
"type": "string"
},
"settings": {
"type": "array"
},
"user_photo": {
"type": "string"
}
},
"required": [
"id",
"external_id",
"first_name",
"last_name",
"username",
"professional_email",
"professional_mobile_phone",
"professional_phone",
"role",
"is_active",
"status",
"settings",
"user_photo"
],
"additionalProperties": false
},
"type_id": {
"type": "number"
},
"title": {
"type": "string"
},
"body": {
"type": "string"
},
"button_text": {
"type": [
"string",
"null"
]
},
"logo": {
"type": [
"string",
"null"
]
},
"banner": {
"type": [
"string",
"null"
]
},
"external_link": {
"type": [
"string",
"null"
]
},
"is_promote_as_top": {
"type": "boolean"
},
"publish_at": {
"type": "string"
},
"editable": {
"type": "boolean"
}
},
"required": [
"id",
"creator",
"type_id",
"title",
"body",
"button_text",
"logo",
"banner",
"external_link",
"is_promote_as_top",
"publish_at",
"editable"
]
}
},
"meta": {
"type": "object",
"properties": {
"pagination": {
"type": "object",
"properties": {
"total": {
"type": "number"
},
"count": {
"type": "number"
},
"per_page": {
"type": "number"
},
"current_page": {
"type": "number"
},
"total_pages": {
"type": "number"
},
"links": {
"type": "object",
"properties": {
"previous": {
"type": "string"
},
"next": {
"type": "string"
}
},
"required": [
"previous",
"next"
]
}
},
"required": [
"total",
"count",
"per_page",
"current_page",
"total_pages",
"links"
],
"additionalProperties": false
}
},
"required": [
"pagination"
]
}
}
}401Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 401
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}403Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 403
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}404Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 404
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}406Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 406
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}422Headers
Content-Type: application/jsonBody
{
"message": "Descriptive error message",
"status_code": 422,
"errors": [
"Error message"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
},
"errors": {
"type": "array"
}
}
}500Headers
Content-Type: application/jsonBody
{
"message": "Internal Error",
"status_code": 500
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}CreatePOST/news
Create news item
Example URI
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: '*'Body
{
"type_id": 1,
"logo": "http://example.com/images/logo.jpg",
"banner": "http://example.com/images/banner.jpg",
"external_link": "http://example.com/news/article-1.html",
"is_promote_as_top": true,
"publish_at": "2019-04-24 11:47:47",
"title": {
"en": "Some text",
"fr": "Du texte",
"de": "Setwas Text",
"es": "Algún texto"
},
"body": {
"en": "Some text",
"fr": "Du texte",
"de": "Setwas Text",
"es": "Algún texto"
},
"button_text": {
"en": "Some text",
"fr": "Du texte",
"de": "Setwas Text",
"es": "Algún texto"
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"type_id": {
"type": "number"
},
"logo": {
"type": [
"string",
"null"
]
},
"banner": {
"type": [
"string",
"null"
]
},
"external_link": {
"type": [
"string",
"null"
]
},
"is_promote_as_top": {
"type": "boolean"
},
"publish_at": {
"type": "string"
},
"title": {
"type": "object",
"properties": {
"en": {
"type": "string"
},
"fr": {
"type": "string"
},
"de": {
"type": "string"
},
"es": {
"type": "string"
}
},
"required": [
"en",
"fr",
"de",
"es"
]
},
"body": {
"type": "object",
"properties": {
"en": {
"type": "string"
},
"fr": {
"type": "string"
},
"de": {
"type": "string"
},
"es": {
"type": "string"
}
},
"required": [
"en",
"fr",
"de",
"es"
]
},
"button_text": {
"type": [
"object",
"null"
],
"properties": {
"en": {
"type": "string"
},
"fr": {
"type": "string"
},
"de": {
"type": "string"
},
"es": {
"type": "string"
}
},
"required": [
"en",
"fr",
"de",
"es"
]
}
},
"required": [
"type_id",
"logo",
"banner",
"external_link",
"is_promote_as_top",
"publish_at",
"title",
"body",
"button_text"
]
}201Headers
Content-Type: application/jsonBody
{
"data": {
"id": 1,
"creator": {
"id": 1,
"external_id": 1,
"first_name": "John",
"last_name": "Snow",
"username": "john_snow",
"professional_email": "jsnow@example.com",
"professional_mobile_phone": "00 33 1 40 00 00 00",
"professional_phone": "00 33 1 40 00 00 00",
"role": [
"bastard",
"king"
],
"is_active": true,
"status": "remote",
"settings": [
"[]"
],
"user_photo": "http://example.com/images/1.jpg"
},
"type_id": 0,
"title": "News title",
"body": "Some text",
"button_text": "Click Me",
"logo": "http://example.com/images/logo.jpg",
"banner": "http://example.com/images/banner.jpg",
"external_link": "http://example.com/news/article-1.html",
"is_promote_as_top": true,
"publish_at": "2019-04-24 11:47:47",
"editable": true
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"creator": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"external_id": {
"type": "number"
},
"first_name": {
"type": "string"
},
"last_name": {
"type": "string"
},
"username": {
"type": "string"
},
"professional_email": {
"type": "string"
},
"professional_mobile_phone": {
"type": "string"
},
"professional_phone": {
"type": "string"
},
"role": {
"type": "array"
},
"is_active": {
"type": "boolean"
},
"status": {
"type": "string"
},
"settings": {
"type": "array"
},
"user_photo": {
"type": "string"
}
},
"required": [
"id",
"external_id",
"first_name",
"last_name",
"username",
"professional_email",
"professional_mobile_phone",
"professional_phone",
"role",
"is_active",
"status",
"settings",
"user_photo"
],
"additionalProperties": false
},
"type_id": {
"type": "number"
},
"title": {
"type": "string"
},
"body": {
"type": "string"
},
"button_text": {
"type": [
"string",
"null"
]
},
"logo": {
"type": [
"string",
"null"
]
},
"banner": {
"type": [
"string",
"null"
]
},
"external_link": {
"type": [
"string",
"null"
]
},
"is_promote_as_top": {
"type": "boolean"
},
"publish_at": {
"type": "string"
},
"editable": {
"type": "boolean"
}
},
"required": [
"id",
"creator",
"type_id",
"title",
"body",
"button_text",
"logo",
"banner",
"external_link",
"is_promote_as_top",
"publish_at",
"editable"
],
"additionalProperties": false
}
}
}400Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 400
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}401Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 401
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}403Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 403
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}404Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 404
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}406Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 406
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}422Headers
Content-Type: application/jsonBody
{
"message": "Descriptive error message",
"status_code": 422,
"errors": [
"Error message"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
},
"errors": {
"type": "array"
}
}
}500Headers
Content-Type: application/jsonBody
{
"message": "Internal Error",
"status_code": 500
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}ShowGET/news/{id}
Fetch single news item
Example URI
- id
number(required) Example: queryId of the News item.
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: '*'200Headers
Content-Type: application/jsonBody
{
"data": {
"id": 1,
"creator": {
"id": 1,
"external_id": 1,
"first_name": "John",
"last_name": "Snow",
"username": "john_snow",
"professional_email": "jsnow@example.com",
"professional_mobile_phone": "00 33 1 40 00 00 00",
"professional_phone": "00 33 1 40 00 00 00",
"role": [
"bastard",
"king"
],
"is_active": true,
"status": "remote",
"settings": [
"[]"
],
"user_photo": "http://example.com/images/1.jpg"
},
"type_id": 0,
"title": "News title",
"body": "Some text",
"button_text": "Click Me",
"logo": "http://example.com/images/logo.jpg",
"banner": "http://example.com/images/banner.jpg",
"external_link": "http://example.com/news/article-1.html",
"is_promote_as_top": true,
"publish_at": "2019-04-24 11:47:47",
"editable": true
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"creator": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"external_id": {
"type": "number"
},
"first_name": {
"type": "string"
},
"last_name": {
"type": "string"
},
"username": {
"type": "string"
},
"professional_email": {
"type": "string"
},
"professional_mobile_phone": {
"type": "string"
},
"professional_phone": {
"type": "string"
},
"role": {
"type": "array"
},
"is_active": {
"type": "boolean"
},
"status": {
"type": "string"
},
"settings": {
"type": "array"
},
"user_photo": {
"type": "string"
}
},
"required": [
"id",
"external_id",
"first_name",
"last_name",
"username",
"professional_email",
"professional_mobile_phone",
"professional_phone",
"role",
"is_active",
"status",
"settings",
"user_photo"
],
"additionalProperties": false
},
"type_id": {
"type": "number"
},
"title": {
"type": "string"
},
"body": {
"type": "string"
},
"button_text": {
"type": [
"string",
"null"
]
},
"logo": {
"type": [
"string",
"null"
]
},
"banner": {
"type": [
"string",
"null"
]
},
"external_link": {
"type": [
"string",
"null"
]
},
"is_promote_as_top": {
"type": "boolean"
},
"publish_at": {
"type": "string"
},
"editable": {
"type": "boolean"
}
},
"required": [
"id",
"creator",
"type_id",
"title",
"body",
"button_text",
"logo",
"banner",
"external_link",
"is_promote_as_top",
"publish_at",
"editable"
],
"additionalProperties": false
}
}
}401Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 401
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}403Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 403
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}404Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 404
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}406Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 406
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}422Headers
Content-Type: application/jsonBody
{
"message": "Descriptive error message",
"status_code": 422,
"errors": [
"Error message"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
},
"errors": {
"type": "array"
}
}
}500Headers
Content-Type: application/jsonBody
{
"message": "Internal Error",
"status_code": 500
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}DeleteDELETE/news/{id}
Delete news item
Example URI
- id
number(required) Example: 123Id of the News item.
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: '*'204Headers
Content-Type: application/json401Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 401
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}403Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 403
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}404Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 404
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}406Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 406
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}422Headers
Content-Type: application/jsonBody
{
"message": "Descriptive error message",
"status_code": 422,
"errors": [
"Error message"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
},
"errors": {
"type": "array"
}
}
}500Headers
Content-Type: application/jsonBody
{
"message": "Internal Error",
"status_code": 500
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}UpdatePATCH/news/{id}
Update news item
Example URI
- id
number(required) Example: 123Id of the News item.
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>Body
{
"type_id": 1,
"logo": "http://example.com/images/logo.jpg",
"banner": "http://example.com/images/banner.jpg",
"external_link": "http://example.com/news/article-1.html",
"is_promote_as_top": true,
"publish_at": "2019-04-24 11:47:47",
"title": {
"en": "Some text",
"fr": "Du texte",
"de": "Setwas Text",
"es": "Algún texto"
},
"body": {
"en": "Some text",
"fr": "Du texte",
"de": "Setwas Text",
"es": "Algún texto"
},
"button_text": {
"en": "Some text",
"fr": "Du texte",
"de": "Setwas Text",
"es": "Algún texto"
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"type_id": {
"type": "number"
},
"logo": {
"type": [
"string",
"null"
]
},
"banner": {
"type": [
"string",
"null"
]
},
"external_link": {
"type": [
"string",
"null"
]
},
"is_promote_as_top": {
"type": "boolean"
},
"publish_at": {
"type": "string"
},
"title": {
"type": "object",
"properties": {
"en": {
"type": "string"
},
"fr": {
"type": "string"
},
"de": {
"type": "string"
},
"es": {
"type": "string"
}
},
"required": [
"en",
"fr",
"de",
"es"
]
},
"body": {
"type": "object",
"properties": {
"en": {
"type": "string"
},
"fr": {
"type": "string"
},
"de": {
"type": "string"
},
"es": {
"type": "string"
}
},
"required": [
"en",
"fr",
"de",
"es"
]
},
"button_text": {
"type": "object",
"properties": {
"en": {
"type": "string"
},
"fr": {
"type": "string"
},
"de": {
"type": "string"
},
"es": {
"type": "string"
}
},
"required": [
"en",
"fr",
"de",
"es"
]
}
}
}202Headers
Content-Type: application/jsonBody
{
"data": {
"id": 1,
"creator": {
"id": 1,
"external_id": 1,
"first_name": "John",
"last_name": "Snow",
"username": "john_snow",
"professional_email": "jsnow@example.com",
"professional_mobile_phone": "00 33 1 40 00 00 00",
"professional_phone": "00 33 1 40 00 00 00",
"role": [
"bastard",
"king"
],
"is_active": true,
"status": "remote",
"settings": [
"[]"
],
"user_photo": "http://example.com/images/1.jpg"
},
"type_id": 0,
"title": "News title",
"body": "Some text",
"button_text": "Click Me",
"logo": "http://example.com/images/logo.jpg",
"banner": "http://example.com/images/banner.jpg",
"external_link": "http://example.com/news/article-1.html",
"is_promote_as_top": true,
"publish_at": "2019-04-24 11:47:47",
"editable": true
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"creator": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"external_id": {
"type": "number"
},
"first_name": {
"type": "string"
},
"last_name": {
"type": "string"
},
"username": {
"type": "string"
},
"professional_email": {
"type": "string"
},
"professional_mobile_phone": {
"type": "string"
},
"professional_phone": {
"type": "string"
},
"role": {
"type": "array"
},
"is_active": {
"type": "boolean"
},
"status": {
"type": "string"
},
"settings": {
"type": "array"
},
"user_photo": {
"type": "string"
}
},
"required": [
"id",
"external_id",
"first_name",
"last_name",
"username",
"professional_email",
"professional_mobile_phone",
"professional_phone",
"role",
"is_active",
"status",
"settings",
"user_photo"
],
"additionalProperties": false
},
"type_id": {
"type": "number"
},
"title": {
"type": "string"
},
"body": {
"type": "string"
},
"button_text": {
"type": [
"string",
"null"
]
},
"logo": {
"type": [
"string",
"null"
]
},
"banner": {
"type": [
"string",
"null"
]
},
"external_link": {
"type": [
"string",
"null"
]
},
"is_promote_as_top": {
"type": "boolean"
},
"publish_at": {
"type": "string"
},
"editable": {
"type": "boolean"
}
},
"required": [
"id",
"creator",
"type_id",
"title",
"body",
"button_text",
"logo",
"banner",
"external_link",
"is_promote_as_top",
"publish_at",
"editable"
],
"additionalProperties": false
}
}
}400Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 400
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}401Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 401
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}403Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 403
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}404Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 404
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}406Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 406
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}422Headers
Content-Type: application/jsonBody
{
"message": "Descriptive error message",
"status_code": 422,
"errors": [
"Error message"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
},
"errors": {
"type": "array"
}
}
}500Headers
Content-Type: application/jsonBody
{
"message": "Internal Error",
"status_code": 500
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}Notifications ¶
Notifications is way to inform users about various types of events
Notifications ¶
ShowGET/notifications/{notification}
Get details for selected notification
Example URI
- notification
number(required) Example: notificationid of the notification
Headers
Accept: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target permission>200Headers
Content-Type: application/jsonBody
{
"data": {
"id": 1,
"author": {
"summary": {
"first_name": {
"id": 1,
"alias": "usr_first_name",
"value": "John"
},
"last_name": {
"id": 1,
"alias": "usr_first_name",
"value": "John"
},
"image": {
"id": 1,
"alias": "usr_first_name",
"value": "John"
},
"is_active": {
"id": 1,
"alias": "usr_first_name",
"value": "John"
},
"email": {
"id": 1,
"alias": "usr_first_name",
"value": "John"
},
"phone_number": ""
},
"pso": {
"id": 1,
"profile_form": {
"id": 1,
"name": "Profile Form",
"description": "Profile Form Description",
"is_active": true,
"active_field": "null"
},
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
},
"categories": [
{
"id": 1,
"name": "Category Name",
"alias": "category_alias"
}
],
"fields": {
"id": 1,
"name": "Field Name",
"position": 5,
"alias": "usr_first_name",
"has_unique_data": false,
"has_value": true,
"removable": false,
"is_active": true,
"list": false,
"read_only": false,
"required": true,
"type": {
"id": 1,
"name": "Data Type Name",
"alias": "data_type_alias",
"settings": [
{
"id": 1,
"name": "Data Type Setting Name",
"alias": "data_type_setting_alias",
"is_required": true
}
],
"supports_collection": false,
"supports_read_only": false,
"supports_unique": false
},
"category": {
"id": 32,
"alias": "usr_identity",
"position": 5,
"system_required": true,
"name": "Identity",
"description": "...",
"is_active": true,
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
}
},
"domains": [
{
"id": 46,
"alias": "usr_global",
"name": "User Global",
"description": "...",
"is_editable": false,
"is_removable": false,
"is_active": true,
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
}
}
],
"privacy_level": {
"id": 123,
"alias": "public",
"name": "Not Sensitive",
"level": 100
},
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
},
"items": [
{
"id": 1,
"name": "Field Name",
"position": 5,
"alias": "usr_first_name",
"has_unique_data": false,
"has_value": true,
"removable": false,
"is_active": true,
"list": false,
"read_only": false,
"required": true,
"type": {
"id": 1,
"name": "Data Type Name",
"alias": "data_type_alias",
"settings": [
{
"id": 1,
"name": "Data Type Setting Name",
"alias": "data_type_setting_alias",
"is_required": true
}
],
"supports_collection": false,
"supports_read_only": false,
"supports_unique": false
},
"category": {
"id": 32,
"alias": "usr_identity",
"position": 5,
"system_required": true,
"name": "Identity",
"description": "...",
"is_active": true,
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
}
},
"domains": [
{
"id": 46,
"alias": "usr_global",
"name": "User Global",
"description": "...",
"is_editable": false,
"is_removable": false,
"is_active": true,
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
}
}
],
"privacy_level": {
"id": 123,
"alias": "public",
"name": "Not Sensitive",
"level": 100
},
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
},
"items": [
{}
],
"options": [
{
"id": 198,
"name": "Chose me!",
"position": 9,
"value": "198",
"is_active": true
}
],
"settings": []
}
],
"options": [
{
"id": 198,
"name": "Chose me!",
"position": 9,
"value": "198",
"is_active": true
}
],
"settings": [],
"is_locked": false,
"value_details": [
"value1",
"value2"
],
"values_count": 2,
"assignment_settings": [
{
"setting": "public",
"value": "1"
}
],
"access_permissions": {
"history": true,
"view": true,
"edit": true
},
"assignment_permissions": {
"permissions": {
"id": 1,
"name": "View",
"alias": "view"
},
"access_list": [
"0",
"1",
"1"
]
}
}
}
},
"title": "Notification Title",
"details": "Notification Details",
"read_at": "2019-01-01 23:34:40",
"effective_date": "2019-01-01 23:34:40",
"expires_at": "2019-01-01 23:34:40",
"created_at": "2019-01-01 23:34:40",
"updated_at": "2019-01-01 23:34:40"
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"author": {
"type": "object",
"properties": {
"summary": {
"type": "object",
"properties": {
"first_name": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"alias": {
"type": "string"
},
"value": {
"type": "string",
"description": "if field support multiple values it can be array"
}
},
"required": [
"id",
"alias",
"value"
]
},
"last_name": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"alias": {
"type": "string"
},
"value": {
"type": "string",
"description": "if field support multiple values it can be array"
}
},
"required": [
"id",
"alias",
"value"
]
},
"image": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"alias": {
"type": "string"
},
"value": {
"type": "string",
"description": "if field support multiple values it can be array"
}
},
"required": [
"id",
"alias",
"value"
]
},
"is_active": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"alias": {
"type": "string"
},
"value": {
"type": "string",
"description": "if field support multiple values it can be array"
}
},
"required": [
"id",
"alias",
"value"
]
},
"email": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"alias": {
"type": "string"
},
"value": {
"type": "string",
"description": "if field support multiple values it can be array"
}
},
"required": [
"id",
"alias",
"value"
]
},
"phone_number": {
"type": "string"
}
},
"required": [
"first_name",
"last_name",
"image",
"is_active",
"email",
"phone_number"
]
},
"pso": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"profile_form": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"active_field": {
"type": [
"string",
"null"
]
}
},
"required": [
"id",
"name",
"description",
"is_active"
]
},
"pso_type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"system_required": {
"type": "boolean"
},
"creation_form_instance_id": {
"type": "number"
},
"profile_form_instance_id": {
"type": "number"
}
},
"required": [
"id",
"name",
"alias",
"description",
"is_active",
"system_required",
"creation_form_instance_id",
"profile_form_instance_id"
]
},
"categories": {
"type": "array"
},
"fields": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"position": {
"type": "number"
},
"alias": {
"type": "string"
},
"has_unique_data": {
"type": "boolean",
"description": "whether field requires values to be unique across system"
},
"has_value": {
"type": "boolean",
"description": "whether field has at least one value submitted"
},
"removable": {
"type": "boolean",
"description": "whether field can be removed from system"
},
"is_active": {
"type": "boolean"
},
"list": {
"type": "boolean",
"description": "whether field can handle collection of values"
},
"read_only": {
"type": "boolean",
"description": "whether field value can be changed"
},
"required": {
"type": "boolean",
"description": "whether field value required by system"
},
"type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"settings": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"is_required": {
"type": "boolean"
}
},
"required": [
"id",
"name",
"alias",
"is_required"
]
}
},
"supports_collection": {
"type": "boolean"
},
"supports_read_only": {
"type": "boolean"
},
"supports_unique": {
"type": "boolean"
}
},
"required": [
"id",
"name",
"alias",
"settings",
"supports_collection",
"supports_read_only",
"supports_unique"
],
"additionalProperties": false
},
"category": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"alias": {
"type": "string"
},
"position": {
"type": "number"
},
"system_required": {
"type": "boolean"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"pso_type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"system_required": {
"type": "boolean"
},
"creation_form_instance_id": {
"type": "number"
},
"profile_form_instance_id": {
"type": "number"
}
},
"required": [
"id",
"name",
"alias",
"description",
"is_active",
"system_required",
"creation_form_instance_id",
"profile_form_instance_id"
],
"additionalProperties": false
}
},
"required": [
"id",
"alias",
"position",
"system_required",
"name",
"description",
"is_active"
],
"additionalProperties": false
},
"domains": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"alias": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"is_editable": {
"type": "boolean"
},
"is_removable": {
"type": "boolean"
},
"is_active": {
"type": "boolean"
},
"pso_type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"system_required": {
"type": "boolean"
},
"creation_form_instance_id": {
"type": "number"
},
"profile_form_instance_id": {
"type": "number"
}
},
"required": [
"id",
"name",
"alias",
"description",
"is_active",
"system_required",
"creation_form_instance_id",
"profile_form_instance_id"
],
"additionalProperties": false
}
},
"required": [
"id",
"alias",
"name",
"description",
"is_editable",
"is_removable",
"is_active"
]
}
},
"privacy_level": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"alias": {
"type": "string"
},
"name": {
"type": "string"
},
"level": {
"type": "number"
}
},
"required": [
"id",
"alias",
"name",
"level"
],
"additionalProperties": false
},
"pso_type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"system_required": {
"type": "boolean"
},
"creation_form_instance_id": {
"type": "number"
},
"profile_form_instance_id": {
"type": "number"
}
},
"required": [
"id",
"name",
"alias",
"description",
"is_active",
"system_required",
"creation_form_instance_id",
"profile_form_instance_id"
],
"additionalProperties": false
},
"items": {
"type": [
"array",
"null"
],
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"position": {
"type": "number"
},
"alias": {
"type": "string"
},
"has_unique_data": {
"type": "boolean",
"description": "whether field requires values to be unique across system"
},
"has_value": {
"type": "boolean",
"description": "whether field has at least one value submitted"
},
"removable": {
"type": "boolean",
"description": "whether field can be removed from system"
},
"is_active": {
"type": "boolean"
},
"list": {
"type": "boolean",
"description": "whether field can handle collection of values"
},
"read_only": {
"type": "boolean",
"description": "whether field value can be changed"
},
"required": {
"type": "boolean",
"description": "whether field value required by system"
},
"type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"settings": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"is_required": {
"type": "boolean"
}
},
"required": [
"id",
"name",
"alias",
"is_required"
]
}
},
"supports_collection": {
"type": "boolean"
},
"supports_read_only": {
"type": "boolean"
},
"supports_unique": {
"type": "boolean"
}
},
"required": [
"id",
"name",
"alias",
"settings",
"supports_collection",
"supports_read_only",
"supports_unique"
],
"additionalProperties": false
},
"category": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"alias": {
"type": "string"
},
"position": {
"type": "number"
},
"system_required": {
"type": "boolean"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"pso_type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"system_required": {
"type": "boolean"
},
"creation_form_instance_id": {
"type": "number"
},
"profile_form_instance_id": {
"type": "number"
}
},
"required": [
"id",
"name",
"alias",
"description",
"is_active",
"system_required",
"creation_form_instance_id",
"profile_form_instance_id"
],
"additionalProperties": false
}
},
"required": [
"id",
"alias",
"position",
"system_required",
"name",
"description",
"is_active"
],
"additionalProperties": false
},
"domains": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"alias": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"is_editable": {
"type": "boolean"
},
"is_removable": {
"type": "boolean"
},
"is_active": {
"type": "boolean"
},
"pso_type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"system_required": {
"type": "boolean"
},
"creation_form_instance_id": {
"type": "number"
},
"profile_form_instance_id": {
"type": "number"
}
},
"required": [
"id",
"name",
"alias",
"description",
"is_active",
"system_required",
"creation_form_instance_id",
"profile_form_instance_id"
],
"additionalProperties": false
}
},
"required": [
"id",
"alias",
"name",
"description",
"is_editable",
"is_removable",
"is_active"
]
}
},
"privacy_level": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"alias": {
"type": "string"
},
"name": {
"type": "string"
},
"level": {
"type": "number"
}
},
"required": [
"id",
"alias",
"name",
"level"
],
"additionalProperties": false
},
"pso_type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"system_required": {
"type": "boolean"
},
"creation_form_instance_id": {
"type": "number"
},
"profile_form_instance_id": {
"type": "number"
}
},
"required": [
"id",
"name",
"alias",
"description",
"is_active",
"system_required",
"creation_form_instance_id",
"profile_form_instance_id"
],
"additionalProperties": false
},
"items": {
"type": [
"array",
"null"
],
"items": {
"type": "object",
"properties": {}
}
},
"options": {
"type": [
"array",
"null"
],
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"position": {
"type": "number"
},
"value": {
"type": "string"
},
"is_active": {
"type": "boolean"
}
},
"required": [
"id",
"name",
"position",
"value",
"is_active"
]
},
"description": "List of options with possible (allowed) values."
},
"settings": {
"type": "array",
"items": {
"type": "string"
},
"description": "Common field settings"
}
},
"required": [
"id",
"name",
"position",
"alias",
"has_unique_data",
"has_value",
"removable",
"is_active",
"list",
"read_only",
"required"
]
}
},
"options": {
"type": [
"array",
"null"
],
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"position": {
"type": "number"
},
"value": {
"type": "string"
},
"is_active": {
"type": "boolean"
}
},
"required": [
"id",
"name",
"position",
"value",
"is_active"
]
},
"description": "List of options with possible (allowed) values."
},
"settings": {
"type": "array",
"items": {
"type": "string"
},
"description": "Common field settings"
},
"is_locked": {
"type": "boolean"
},
"value_details": {
"type": "array"
},
"values_count": {
"type": "number"
},
"assignment_settings": {
"type": "array"
},
"access_permissions": {
"type": "object",
"properties": {
"history": {
"type": "boolean"
},
"view": {
"type": "boolean"
},
"edit": {
"type": "boolean"
}
},
"required": [
"history",
"view",
"edit"
]
},
"assignment_permissions": {
"type": "object",
"properties": {
"permissions": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
}
},
"required": [
"id",
"name",
"alias"
]
},
"access_list": {
"type": "array",
"description": "user, manager, hr"
}
},
"required": [
"permissions",
"access_list"
]
}
},
"required": [
"id",
"name",
"position",
"alias",
"has_unique_data",
"has_value",
"removable",
"is_active",
"list",
"read_only",
"required",
"is_locked",
"value_details",
"values_count",
"assignment_settings",
"access_permissions",
"assignment_permissions"
]
}
},
"required": [
"id"
]
}
},
"required": [
"summary",
"pso"
]
},
"title": {
"type": "string"
},
"details": {
"type": "string"
},
"read_at": {
"type": "string"
},
"effective_date": {
"type": "string"
},
"expires_at": {
"type": "string"
},
"created_at": {
"type": "string"
},
"updated_at": {
"type": "string"
}
},
"required": [
"id",
"author",
"title",
"details",
"read_at",
"effective_date",
"expires_at",
"created_at",
"updated_at"
]
}
}
}401Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 401
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}403Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 403
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}404Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 404
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}406Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 406
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}422Headers
Content-Type: application/jsonBody
{
"message": "Descriptive error message",
"status_code": 422,
"errors": [
"Error message"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
},
"errors": {
"type": "array"
}
}
}500Headers
Content-Type: application/jsonBody
{
"message": "Internal Error",
"status_code": 500
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}Common ListGET/notifications{?user_id,expires-after,effective-date,actual,not-read,page,per-page,no-pagination}
Get list of notifications matches specified filters
Example URI
- user_id
number(required) Example: 1id of user for filtering
- expires-after
date-time(optional) Example: 2020-01-01 30:30:30format YYYY-MM-DD HH:II:SS
- effective-date
date-time(optional) Example: 2020-01-01 30:30:30format YYYY-MM-DD HH:II:SS
- actual
bool(required) Example: trueget only not expired notifications
- not-read
bool(required) Example: trueget only not read notifications
- page
number(required) Example: 1Page number.
1by default- per-page
number(required) Example: 10Number of items per page,
25by default- no-pagination
boolean(required) Example: falseif presented and positive pagination will not be applied. All available items will be returned.
Note: it may have significant impact on the performance
Note: once this option positive and presented -
metaattribute with pagination data will be omit in response
Headers
Accept: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target permission>200Headers
Content-Type: application/jsonBody
{
"data": [
{
"id": 1,
"author": {
"summary": {
"first_name": {
"id": 1,
"alias": "usr_first_name",
"value": "John"
},
"last_name": {
"id": 1,
"alias": "usr_first_name",
"value": "John"
},
"image": {
"id": 1,
"alias": "usr_first_name",
"value": "John"
},
"is_active": {
"id": 1,
"alias": "usr_first_name",
"value": "John"
},
"email": {
"id": 1,
"alias": "usr_first_name",
"value": "John"
},
"phone_number": ""
},
"pso": {
"id": 1,
"profile_form": {
"id": 1,
"name": "Profile Form",
"description": "Profile Form Description",
"is_active": true,
"active_field": "null"
},
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
},
"categories": [
{
"id": 1,
"name": "Category Name",
"alias": "category_alias"
}
],
"fields": {
"id": 1,
"name": "Field Name",
"position": 5,
"alias": "usr_first_name",
"has_unique_data": false,
"has_value": true,
"removable": false,
"is_active": true,
"list": false,
"read_only": false,
"required": true,
"type": {
"id": 1,
"name": "Data Type Name",
"alias": "data_type_alias",
"settings": [
{
"id": 1,
"name": "Data Type Setting Name",
"alias": "data_type_setting_alias",
"is_required": true
}
],
"supports_collection": false,
"supports_read_only": false,
"supports_unique": false
},
"category": {
"id": 32,
"alias": "usr_identity",
"position": 5,
"system_required": true,
"name": "Identity",
"description": "...",
"is_active": true,
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
}
},
"domains": [
{
"id": 46,
"alias": "usr_global",
"name": "User Global",
"description": "...",
"is_editable": false,
"is_removable": false,
"is_active": true,
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
}
}
],
"privacy_level": {
"id": 123,
"alias": "public",
"name": "Not Sensitive",
"level": 100
},
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
},
"items": [
{
"id": 1,
"name": "Field Name",
"position": 5,
"alias": "usr_first_name",
"has_unique_data": false,
"has_value": true,
"removable": false,
"is_active": true,
"list": false,
"read_only": false,
"required": true,
"type": {
"id": 1,
"name": "Data Type Name",
"alias": "data_type_alias",
"settings": [
{
"id": 1,
"name": "Data Type Setting Name",
"alias": "data_type_setting_alias",
"is_required": true
}
],
"supports_collection": false,
"supports_read_only": false,
"supports_unique": false
},
"category": {
"id": 32,
"alias": "usr_identity",
"position": 5,
"system_required": true,
"name": "Identity",
"description": "...",
"is_active": true,
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
}
},
"domains": [
{
"id": 46,
"alias": "usr_global",
"name": "User Global",
"description": "...",
"is_editable": false,
"is_removable": false,
"is_active": true,
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
}
}
],
"privacy_level": {
"id": 123,
"alias": "public",
"name": "Not Sensitive",
"level": 100
},
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
},
"items": [
{}
],
"options": [
{
"id": 198,
"name": "Chose me!",
"position": 9,
"value": "198",
"is_active": true
}
],
"settings": []
}
],
"options": [
{
"id": 198,
"name": "Chose me!",
"position": 9,
"value": "198",
"is_active": true
}
],
"settings": [],
"is_locked": false,
"value_details": [
"value1",
"value2"
],
"values_count": 2,
"assignment_settings": [
{
"setting": "public",
"value": "1"
}
],
"access_permissions": {
"history": true,
"view": true,
"edit": true
},
"assignment_permissions": {
"permissions": {
"id": 1,
"name": "View",
"alias": "view"
},
"access_list": [
"0",
"1",
"1"
]
}
}
}
},
"title": "Notification Title",
"details": "Notification Details",
"read_at": "2019-01-01 23:34:40",
"effective_date": "2019-01-01 23:34:40",
"expires_at": "2019-01-01 23:34:40",
"created_at": "2019-01-01 23:34:40",
"updated_at": "2019-01-01 23:34:40"
}
],
"meta": {
"pagination": {
"total": 238,
"count": 25,
"per_page": 25,
"current_page": 2,
"total_pages": 10,
"links": {
"previous": "http://example.com/api/<endpoint>?page=1",
"next": "http://example.com/api/<endpoint>?page=3"
}
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"author": {
"type": "object",
"properties": {
"summary": {
"type": "object",
"properties": {
"first_name": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"alias": {
"type": "string"
},
"value": {
"type": "string",
"description": "if field support multiple values it can be array"
}
},
"required": [
"id",
"alias",
"value"
]
},
"last_name": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"alias": {
"type": "string"
},
"value": {
"type": "string",
"description": "if field support multiple values it can be array"
}
},
"required": [
"id",
"alias",
"value"
]
},
"image": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"alias": {
"type": "string"
},
"value": {
"type": "string",
"description": "if field support multiple values it can be array"
}
},
"required": [
"id",
"alias",
"value"
]
},
"is_active": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"alias": {
"type": "string"
},
"value": {
"type": "string",
"description": "if field support multiple values it can be array"
}
},
"required": [
"id",
"alias",
"value"
]
},
"email": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"alias": {
"type": "string"
},
"value": {
"type": "string",
"description": "if field support multiple values it can be array"
}
},
"required": [
"id",
"alias",
"value"
]
},
"phone_number": {
"type": "string"
}
},
"required": [
"first_name",
"last_name",
"image",
"is_active",
"email",
"phone_number"
]
},
"pso": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"profile_form": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"active_field": {
"type": [
"string",
"null"
]
}
},
"required": [
"id",
"name",
"description",
"is_active"
]
},
"pso_type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"system_required": {
"type": "boolean"
},
"creation_form_instance_id": {
"type": "number"
},
"profile_form_instance_id": {
"type": "number"
}
},
"required": [
"id",
"name",
"alias",
"description",
"is_active",
"system_required",
"creation_form_instance_id",
"profile_form_instance_id"
]
},
"categories": {
"type": "array"
},
"fields": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"position": {
"type": "number"
},
"alias": {
"type": "string"
},
"has_unique_data": {
"type": "boolean",
"description": "whether field requires values to be unique across system"
},
"has_value": {
"type": "boolean",
"description": "whether field has at least one value submitted"
},
"removable": {
"type": "boolean",
"description": "whether field can be removed from system"
},
"is_active": {
"type": "boolean"
},
"list": {
"type": "boolean",
"description": "whether field can handle collection of values"
},
"read_only": {
"type": "boolean",
"description": "whether field value can be changed"
},
"required": {
"type": "boolean",
"description": "whether field value required by system"
},
"type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"settings": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"is_required": {
"type": "boolean"
}
},
"required": [
"id",
"name",
"alias",
"is_required"
]
}
},
"supports_collection": {
"type": "boolean"
},
"supports_read_only": {
"type": "boolean"
},
"supports_unique": {
"type": "boolean"
}
},
"required": [
"id",
"name",
"alias",
"settings",
"supports_collection",
"supports_read_only",
"supports_unique"
],
"additionalProperties": false
},
"category": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"alias": {
"type": "string"
},
"position": {
"type": "number"
},
"system_required": {
"type": "boolean"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"pso_type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"system_required": {
"type": "boolean"
},
"creation_form_instance_id": {
"type": "number"
},
"profile_form_instance_id": {
"type": "number"
}
},
"required": [
"id",
"name",
"alias",
"description",
"is_active",
"system_required",
"creation_form_instance_id",
"profile_form_instance_id"
],
"additionalProperties": false
}
},
"required": [
"id",
"alias",
"position",
"system_required",
"name",
"description",
"is_active"
],
"additionalProperties": false
},
"domains": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"alias": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"is_editable": {
"type": "boolean"
},
"is_removable": {
"type": "boolean"
},
"is_active": {
"type": "boolean"
},
"pso_type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"system_required": {
"type": "boolean"
},
"creation_form_instance_id": {
"type": "number"
},
"profile_form_instance_id": {
"type": "number"
}
},
"required": [
"id",
"name",
"alias",
"description",
"is_active",
"system_required",
"creation_form_instance_id",
"profile_form_instance_id"
],
"additionalProperties": false
}
},
"required": [
"id",
"alias",
"name",
"description",
"is_editable",
"is_removable",
"is_active"
]
}
},
"privacy_level": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"alias": {
"type": "string"
},
"name": {
"type": "string"
},
"level": {
"type": "number"
}
},
"required": [
"id",
"alias",
"name",
"level"
],
"additionalProperties": false
},
"pso_type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"system_required": {
"type": "boolean"
},
"creation_form_instance_id": {
"type": "number"
},
"profile_form_instance_id": {
"type": "number"
}
},
"required": [
"id",
"name",
"alias",
"description",
"is_active",
"system_required",
"creation_form_instance_id",
"profile_form_instance_id"
],
"additionalProperties": false
},
"items": {
"type": [
"array",
"null"
],
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"position": {
"type": "number"
},
"alias": {
"type": "string"
},
"has_unique_data": {
"type": "boolean",
"description": "whether field requires values to be unique across system"
},
"has_value": {
"type": "boolean",
"description": "whether field has at least one value submitted"
},
"removable": {
"type": "boolean",
"description": "whether field can be removed from system"
},
"is_active": {
"type": "boolean"
},
"list": {
"type": "boolean",
"description": "whether field can handle collection of values"
},
"read_only": {
"type": "boolean",
"description": "whether field value can be changed"
},
"required": {
"type": "boolean",
"description": "whether field value required by system"
},
"type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"settings": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"is_required": {
"type": "boolean"
}
},
"required": [
"id",
"name",
"alias",
"is_required"
]
}
},
"supports_collection": {
"type": "boolean"
},
"supports_read_only": {
"type": "boolean"
},
"supports_unique": {
"type": "boolean"
}
},
"required": [
"id",
"name",
"alias",
"settings",
"supports_collection",
"supports_read_only",
"supports_unique"
],
"additionalProperties": false
},
"category": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"alias": {
"type": "string"
},
"position": {
"type": "number"
},
"system_required": {
"type": "boolean"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"pso_type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"system_required": {
"type": "boolean"
},
"creation_form_instance_id": {
"type": "number"
},
"profile_form_instance_id": {
"type": "number"
}
},
"required": [
"id",
"name",
"alias",
"description",
"is_active",
"system_required",
"creation_form_instance_id",
"profile_form_instance_id"
],
"additionalProperties": false
}
},
"required": [
"id",
"alias",
"position",
"system_required",
"name",
"description",
"is_active"
],
"additionalProperties": false
},
"domains": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"alias": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"is_editable": {
"type": "boolean"
},
"is_removable": {
"type": "boolean"
},
"is_active": {
"type": "boolean"
},
"pso_type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"system_required": {
"type": "boolean"
},
"creation_form_instance_id": {
"type": "number"
},
"profile_form_instance_id": {
"type": "number"
}
},
"required": [
"id",
"name",
"alias",
"description",
"is_active",
"system_required",
"creation_form_instance_id",
"profile_form_instance_id"
],
"additionalProperties": false
}
},
"required": [
"id",
"alias",
"name",
"description",
"is_editable",
"is_removable",
"is_active"
]
}
},
"privacy_level": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"alias": {
"type": "string"
},
"name": {
"type": "string"
},
"level": {
"type": "number"
}
},
"required": [
"id",
"alias",
"name",
"level"
],
"additionalProperties": false
},
"pso_type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"system_required": {
"type": "boolean"
},
"creation_form_instance_id": {
"type": "number"
},
"profile_form_instance_id": {
"type": "number"
}
},
"required": [
"id",
"name",
"alias",
"description",
"is_active",
"system_required",
"creation_form_instance_id",
"profile_form_instance_id"
],
"additionalProperties": false
},
"items": {
"type": [
"array",
"null"
],
"items": {
"type": "object",
"properties": {}
}
},
"options": {
"type": [
"array",
"null"
],
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"position": {
"type": "number"
},
"value": {
"type": "string"
},
"is_active": {
"type": "boolean"
}
},
"required": [
"id",
"name",
"position",
"value",
"is_active"
]
},
"description": "List of options with possible (allowed) values."
},
"settings": {
"type": "array",
"items": {
"type": "string"
},
"description": "Common field settings"
}
},
"required": [
"id",
"name",
"position",
"alias",
"has_unique_data",
"has_value",
"removable",
"is_active",
"list",
"read_only",
"required"
]
}
},
"options": {
"type": [
"array",
"null"
],
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"position": {
"type": "number"
},
"value": {
"type": "string"
},
"is_active": {
"type": "boolean"
}
},
"required": [
"id",
"name",
"position",
"value",
"is_active"
]
},
"description": "List of options with possible (allowed) values."
},
"settings": {
"type": "array",
"items": {
"type": "string"
},
"description": "Common field settings"
},
"is_locked": {
"type": "boolean"
},
"value_details": {
"type": "array"
},
"values_count": {
"type": "number"
},
"assignment_settings": {
"type": "array"
},
"access_permissions": {
"type": "object",
"properties": {
"history": {
"type": "boolean"
},
"view": {
"type": "boolean"
},
"edit": {
"type": "boolean"
}
},
"required": [
"history",
"view",
"edit"
]
},
"assignment_permissions": {
"type": "object",
"properties": {
"permissions": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
}
},
"required": [
"id",
"name",
"alias"
]
},
"access_list": {
"type": "array",
"description": "user, manager, hr"
}
},
"required": [
"permissions",
"access_list"
]
}
},
"required": [
"id",
"name",
"position",
"alias",
"has_unique_data",
"has_value",
"removable",
"is_active",
"list",
"read_only",
"required",
"is_locked",
"value_details",
"values_count",
"assignment_settings",
"access_permissions",
"assignment_permissions"
]
}
},
"required": [
"id"
]
}
},
"required": [
"summary",
"pso"
]
},
"title": {
"type": "string"
},
"details": {
"type": "string"
},
"read_at": {
"type": "string"
},
"effective_date": {
"type": "string"
},
"expires_at": {
"type": "string"
},
"created_at": {
"type": "string"
},
"updated_at": {
"type": "string"
}
},
"required": [
"id",
"author",
"title",
"details",
"read_at",
"effective_date",
"expires_at",
"created_at",
"updated_at"
]
}
},
"meta": {
"type": "object",
"properties": {
"pagination": {
"type": "object",
"properties": {
"total": {
"type": "number"
},
"count": {
"type": "number"
},
"per_page": {
"type": "number"
},
"current_page": {
"type": "number"
},
"total_pages": {
"type": "number"
},
"links": {
"type": "object",
"properties": {
"previous": {
"type": "string"
},
"next": {
"type": "string"
}
},
"required": [
"previous",
"next"
]
}
},
"required": [
"total",
"count",
"per_page",
"current_page",
"total_pages",
"links"
],
"additionalProperties": false
}
},
"required": [
"pagination"
]
}
}
}401Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 401
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}403Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 403
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}404Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 404
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}406Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 406
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}422Headers
Content-Type: application/jsonBody
{
"message": "Descriptive error message",
"status_code": 422,
"errors": [
"Error message"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
},
"errors": {
"type": "array"
}
}
}500Headers
Content-Type: application/jsonBody
{
"message": "Internal Error",
"status_code": 500
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}CreatePOST/notifications
Create notification
Example URI
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>Body
{
"user_id": 1,
"relation": "user",
"raw_recipient": "user@email.com",
"title": {
"en": "Some text",
"fr": "Du texte",
"de": "Setwas Text",
"es": "Algún texto"
},
"details": {
"en": "Some text",
"fr": "Du texte",
"de": "Setwas Text",
"es": "Algún texto"
},
"effective_date": "2019-01-01 23:34:40",
"expires_at": "2019-01-01 23:34:40",
"substitutions": [
"{@usr_first_name}",
"{$usr_first_name}"
],
"transport": "email"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"user_id": {
"type": "number",
"description": "required without raw_recipient"
},
"relation": {
"type": "string",
"enum": [
"user",
"manager",
"hr",
"owner",
"admin"
]
},
"raw_recipient": {
"type": "string",
"description": "required without user_id"
},
"title": {
"type": "object",
"properties": {
"en": {
"type": "string"
},
"fr": {
"type": "string"
},
"de": {
"type": "string"
},
"es": {
"type": "string"
}
},
"required": [
"en",
"fr",
"de",
"es"
]
},
"details": {
"type": "object",
"properties": {
"en": {
"type": "string"
},
"fr": {
"type": "string"
},
"de": {
"type": "string"
},
"es": {
"type": "string"
}
},
"required": [
"en",
"fr",
"de",
"es"
]
},
"effective_date": {
"type": "string"
},
"expires_at": {
"type": "string"
},
"substitutions": {
"type": "array"
},
"transport": {
"type": "string",
"enum": [
"email",
"http",
"push"
]
}
},
"required": [
"title",
"effective_date",
"expires_at",
"transport"
]
}201Headers
Content-Type: application/json400Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 400
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}401Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 401
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}403Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 403
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}404Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 404
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}406Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 406
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}422Headers
Content-Type: application/jsonBody
{
"message": "Descriptive error message",
"status_code": 422,
"errors": [
"Error message"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
},
"errors": {
"type": "array"
}
}
}500Headers
Content-Type: application/jsonBody
{
"message": "Internal Error",
"status_code": 500
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}DeleteDELETE/notifications/{notification}
Delete single notification
Example URI
- notification
string(required) Example: notificationid of notification
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>204Headers
Content-Type: application/json400Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 400
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}401Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 401
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}403Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 403
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}404Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 404
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}406Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 406
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}422Headers
Content-Type: application/jsonBody
{
"message": "Descriptive error message",
"status_code": 422,
"errors": [
"Error message"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
},
"errors": {
"type": "array"
}
}
}500Headers
Content-Type: application/jsonBody
{
"message": "Internal Error",
"status_code": 500
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}ShowGET/notifications/count{?user_id,actual,not-read}
Get notifications count
Example URI
- user_id
number(required) Example: 1id of user for filtering
- actual
bool(required) Example: trueuse only not expired notifications for count
- not-read
bool(required) Example: trueuse only not read notifications for count
Headers
Accept: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target permission>200Headers
Content-Type: application/jsonBody
{
"data": {
"count": 10
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"count": {
"type": "number"
}
},
"required": [
"count"
]
}
}
}401Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 401
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}403Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 403
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}404Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 404
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}406Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 406
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}422Headers
Content-Type: application/jsonBody
{
"message": "Descriptive error message",
"status_code": 422,
"errors": [
"Error message"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
},
"errors": {
"type": "array"
}
}
}500Headers
Content-Type: application/jsonBody
{
"message": "Internal Error",
"status_code": 500
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}Mark as readPATCH/notifications/mark-as-read
Mark all unread notifications as read.
Example URI
Headers
Accept: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target permission>204Headers
Content-Type: application/json401Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 401
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}403Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 403
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}404Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 404
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}406Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 406
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}422Headers
Content-Type: application/jsonBody
{
"message": "Descriptive error message",
"status_code": 422,
"errors": [
"Error message"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
},
"errors": {
"type": "array"
}
}
}500Headers
Content-Type: application/jsonBody
{
"message": "Internal Error",
"status_code": 500
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}Operators ¶
Condition Operators
List ¶
ListGET/operators
Fetch list of available data- type specific operators
Example URI
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>200Headers
Content-Type: application/jsonBody
{
"data": [
{
"data_type": "number",
"comparison_operators": [
{
"name": "Is equal to",
"operator": "==",
"type": "binary"
}
],
"arithmetic_operators": [
{
"name": "Is equal to",
"operator": "==",
"type": "binary"
}
]
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"data_type": {
"type": "string"
},
"comparison_operators": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"operator": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"binary",
"unary"
]
}
},
"required": [
"name",
"operator"
]
}
},
"arithmetic_operators": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"operator": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"binary",
"unary"
]
}
},
"required": [
"name",
"operator"
]
}
}
},
"required": [
"data_type"
]
}
}
}
}401Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 401
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}403Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 403
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}404Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 404
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}406Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 406
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}422Headers
Content-Type: application/jsonBody
{
"message": "Descriptive error message",
"status_code": 422,
"errors": [
"Error message"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
},
"errors": {
"type": "array"
}
}
}500Headers
Content-Type: application/jsonBody
{
"message": "Internal Error",
"status_code": 500
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}Polls ¶
Access permissions:
poll_dashboard.view- ability to view polls
Polls ¶
ShowGET/polls/{poll}/results
Fetch results for specified poll
Example URI
- poll
number(required) Example: 1id of the poll
Headers
Accept: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target permission>200Headers
Content-Type: application/jsonBody
{
"data": {
"id": 1,
"name": "Poll Name",
"starts_at": "2019-01-24 15:34:58",
"questions": {
"name": "question name",
"data_type": "data_type_alias",
"answers": {
"value": "value",
"count": 1
}
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"starts_at": {
"type": "string"
},
"questions": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"data_type": {
"type": "string"
},
"answers": {
"type": "object",
"properties": {
"value": {
"type": "string"
},
"count": {
"type": "number"
}
},
"required": [
"value",
"count"
]
}
},
"required": [
"name",
"data_type",
"answers"
]
}
},
"required": [
"id",
"name",
"starts_at",
"questions"
]
}
}
}401Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 401
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}403Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 403
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}404Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 404
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}406Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 406
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}422Headers
Content-Type: application/jsonBody
{
"message": "Descriptive error message",
"status_code": 422,
"errors": [
"Error message"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
},
"errors": {
"type": "array"
}
}
}500Headers
Content-Type: application/jsonBody
{
"message": "Internal Error",
"status_code": 500
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}Pso ¶
Access permissions:
-
global_search.view.*- ability to view any pso and profile fields -
global_search.view.{pso_type_alias}- ability to view pso and profile fields form specific pso type
Pso ¶
ShowGET/psos/{pso}
Get details of pso
Example URI
- pso
number(required) Example: 1id of the pso
Headers
Accept: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target permission>200Headers
Content-Type: application/jsonBody
{
"data": {
"summary": {
"first_name": {
"id": 1,
"alias": "usr_first_name",
"value": "John"
},
"last_name": {
"id": 1,
"alias": "usr_first_name",
"value": "John"
},
"image": {
"id": 1,
"alias": "usr_first_name",
"value": "John"
},
"is_active": {
"id": 1,
"alias": "usr_first_name",
"value": "John"
},
"email": {
"id": 1,
"alias": "usr_first_name",
"value": "John"
},
"phone_number": ""
},
"pso": {
"id": 1,
"profile_form": {
"id": 1,
"name": "Profile Form",
"description": "Profile Form Description",
"is_active": true,
"active_field": "null"
},
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
},
"categories": [
{
"id": 1,
"name": "Category Name",
"alias": "category_alias"
}
],
"fields": {
"id": 1,
"name": "Field Name",
"position": 5,
"alias": "usr_first_name",
"has_unique_data": false,
"has_value": true,
"removable": false,
"is_active": true,
"list": false,
"read_only": false,
"required": true,
"type": {
"id": 1,
"name": "Data Type Name",
"alias": "data_type_alias",
"settings": [
{
"id": 1,
"name": "Data Type Setting Name",
"alias": "data_type_setting_alias",
"is_required": true
}
],
"supports_collection": false,
"supports_read_only": false,
"supports_unique": false
},
"category": {
"id": 32,
"alias": "usr_identity",
"position": 5,
"system_required": true,
"name": "Identity",
"description": "...",
"is_active": true,
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
}
},
"domains": [
{
"id": 46,
"alias": "usr_global",
"name": "User Global",
"description": "...",
"is_editable": false,
"is_removable": false,
"is_active": true,
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
}
}
],
"privacy_level": {
"id": 123,
"alias": "public",
"name": "Not Sensitive",
"level": 100
},
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
},
"items": [
{
"id": 1,
"name": "Field Name",
"position": 5,
"alias": "usr_first_name",
"has_unique_data": false,
"has_value": true,
"removable": false,
"is_active": true,
"list": false,
"read_only": false,
"required": true,
"type": {
"id": 1,
"name": "Data Type Name",
"alias": "data_type_alias",
"settings": [
{
"id": 1,
"name": "Data Type Setting Name",
"alias": "data_type_setting_alias",
"is_required": true
}
],
"supports_collection": false,
"supports_read_only": false,
"supports_unique": false
},
"category": {
"id": 32,
"alias": "usr_identity",
"position": 5,
"system_required": true,
"name": "Identity",
"description": "...",
"is_active": true,
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
}
},
"domains": [
{
"id": 46,
"alias": "usr_global",
"name": "User Global",
"description": "...",
"is_editable": false,
"is_removable": false,
"is_active": true,
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
}
}
],
"privacy_level": {
"id": 123,
"alias": "public",
"name": "Not Sensitive",
"level": 100
},
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
},
"items": [
{}
],
"options": [
{
"id": 198,
"name": "Chose me!",
"position": 9,
"value": "198",
"is_active": true
}
],
"settings": []
}
],
"options": [
{
"id": 198,
"name": "Chose me!",
"position": 9,
"value": "198",
"is_active": true
}
],
"settings": [],
"is_locked": false,
"value_details": [
"value1",
"value2"
],
"values_count": 2,
"assignment_settings": [
{
"setting": "public",
"value": "1"
}
],
"access_permissions": {
"history": true,
"view": true,
"edit": true
},
"assignment_permissions": {
"permissions": {
"id": 1,
"name": "View",
"alias": "view"
},
"access_list": [
"0",
"1",
"1"
]
}
}
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"summary": {
"type": "object",
"properties": {
"first_name": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"alias": {
"type": "string"
},
"value": {
"type": "string",
"description": "if field support multiple values it can be array"
}
},
"required": [
"id",
"alias",
"value"
]
},
"last_name": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"alias": {
"type": "string"
},
"value": {
"type": "string",
"description": "if field support multiple values it can be array"
}
},
"required": [
"id",
"alias",
"value"
]
},
"image": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"alias": {
"type": "string"
},
"value": {
"type": "string",
"description": "if field support multiple values it can be array"
}
},
"required": [
"id",
"alias",
"value"
]
},
"is_active": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"alias": {
"type": "string"
},
"value": {
"type": "string",
"description": "if field support multiple values it can be array"
}
},
"required": [
"id",
"alias",
"value"
]
},
"email": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"alias": {
"type": "string"
},
"value": {
"type": "string",
"description": "if field support multiple values it can be array"
}
},
"required": [
"id",
"alias",
"value"
]
},
"phone_number": {
"type": "string"
}
},
"required": [
"first_name",
"last_name",
"image",
"is_active",
"email",
"phone_number"
]
},
"pso": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"profile_form": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"active_field": {
"type": [
"string",
"null"
]
}
},
"required": [
"id",
"name",
"description",
"is_active"
]
},
"pso_type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"system_required": {
"type": "boolean"
},
"creation_form_instance_id": {
"type": "number"
},
"profile_form_instance_id": {
"type": "number"
}
},
"required": [
"id",
"name",
"alias",
"description",
"is_active",
"system_required",
"creation_form_instance_id",
"profile_form_instance_id"
]
},
"categories": {
"type": "array"
},
"fields": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"position": {
"type": "number"
},
"alias": {
"type": "string"
},
"has_unique_data": {
"type": "boolean",
"description": "whether field requires values to be unique across system"
},
"has_value": {
"type": "boolean",
"description": "whether field has at least one value submitted"
},
"removable": {
"type": "boolean",
"description": "whether field can be removed from system"
},
"is_active": {
"type": "boolean"
},
"list": {
"type": "boolean",
"description": "whether field can handle collection of values"
},
"read_only": {
"type": "boolean",
"description": "whether field value can be changed"
},
"required": {
"type": "boolean",
"description": "whether field value required by system"
},
"type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"settings": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"is_required": {
"type": "boolean"
}
},
"required": [
"id",
"name",
"alias",
"is_required"
]
}
},
"supports_collection": {
"type": "boolean"
},
"supports_read_only": {
"type": "boolean"
},
"supports_unique": {
"type": "boolean"
}
},
"required": [
"id",
"name",
"alias",
"settings",
"supports_collection",
"supports_read_only",
"supports_unique"
],
"additionalProperties": false
},
"category": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"alias": {
"type": "string"
},
"position": {
"type": "number"
},
"system_required": {
"type": "boolean"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"pso_type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"system_required": {
"type": "boolean"
},
"creation_form_instance_id": {
"type": "number"
},
"profile_form_instance_id": {
"type": "number"
}
},
"required": [
"id",
"name",
"alias",
"description",
"is_active",
"system_required",
"creation_form_instance_id",
"profile_form_instance_id"
],
"additionalProperties": false
}
},
"required": [
"id",
"alias",
"position",
"system_required",
"name",
"description",
"is_active"
],
"additionalProperties": false
},
"domains": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"alias": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"is_editable": {
"type": "boolean"
},
"is_removable": {
"type": "boolean"
},
"is_active": {
"type": "boolean"
},
"pso_type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"system_required": {
"type": "boolean"
},
"creation_form_instance_id": {
"type": "number"
},
"profile_form_instance_id": {
"type": "number"
}
},
"required": [
"id",
"name",
"alias",
"description",
"is_active",
"system_required",
"creation_form_instance_id",
"profile_form_instance_id"
],
"additionalProperties": false
}
},
"required": [
"id",
"alias",
"name",
"description",
"is_editable",
"is_removable",
"is_active"
]
}
},
"privacy_level": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"alias": {
"type": "string"
},
"name": {
"type": "string"
},
"level": {
"type": "number"
}
},
"required": [
"id",
"alias",
"name",
"level"
],
"additionalProperties": false
},
"pso_type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"system_required": {
"type": "boolean"
},
"creation_form_instance_id": {
"type": "number"
},
"profile_form_instance_id": {
"type": "number"
}
},
"required": [
"id",
"name",
"alias",
"description",
"is_active",
"system_required",
"creation_form_instance_id",
"profile_form_instance_id"
],
"additionalProperties": false
},
"items": {
"type": [
"array",
"null"
],
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"position": {
"type": "number"
},
"alias": {
"type": "string"
},
"has_unique_data": {
"type": "boolean",
"description": "whether field requires values to be unique across system"
},
"has_value": {
"type": "boolean",
"description": "whether field has at least one value submitted"
},
"removable": {
"type": "boolean",
"description": "whether field can be removed from system"
},
"is_active": {
"type": "boolean"
},
"list": {
"type": "boolean",
"description": "whether field can handle collection of values"
},
"read_only": {
"type": "boolean",
"description": "whether field value can be changed"
},
"required": {
"type": "boolean",
"description": "whether field value required by system"
},
"type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"settings": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"is_required": {
"type": "boolean"
}
},
"required": [
"id",
"name",
"alias",
"is_required"
]
}
},
"supports_collection": {
"type": "boolean"
},
"supports_read_only": {
"type": "boolean"
},
"supports_unique": {
"type": "boolean"
}
},
"required": [
"id",
"name",
"alias",
"settings",
"supports_collection",
"supports_read_only",
"supports_unique"
],
"additionalProperties": false
},
"category": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"alias": {
"type": "string"
},
"position": {
"type": "number"
},
"system_required": {
"type": "boolean"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"pso_type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"system_required": {
"type": "boolean"
},
"creation_form_instance_id": {
"type": "number"
},
"profile_form_instance_id": {
"type": "number"
}
},
"required": [
"id",
"name",
"alias",
"description",
"is_active",
"system_required",
"creation_form_instance_id",
"profile_form_instance_id"
],
"additionalProperties": false
}
},
"required": [
"id",
"alias",
"position",
"system_required",
"name",
"description",
"is_active"
],
"additionalProperties": false
},
"domains": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"alias": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"is_editable": {
"type": "boolean"
},
"is_removable": {
"type": "boolean"
},
"is_active": {
"type": "boolean"
},
"pso_type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"system_required": {
"type": "boolean"
},
"creation_form_instance_id": {
"type": "number"
},
"profile_form_instance_id": {
"type": "number"
}
},
"required": [
"id",
"name",
"alias",
"description",
"is_active",
"system_required",
"creation_form_instance_id",
"profile_form_instance_id"
],
"additionalProperties": false
}
},
"required": [
"id",
"alias",
"name",
"description",
"is_editable",
"is_removable",
"is_active"
]
}
},
"privacy_level": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"alias": {
"type": "string"
},
"name": {
"type": "string"
},
"level": {
"type": "number"
}
},
"required": [
"id",
"alias",
"name",
"level"
],
"additionalProperties": false
},
"pso_type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"system_required": {
"type": "boolean"
},
"creation_form_instance_id": {
"type": "number"
},
"profile_form_instance_id": {
"type": "number"
}
},
"required": [
"id",
"name",
"alias",
"description",
"is_active",
"system_required",
"creation_form_instance_id",
"profile_form_instance_id"
],
"additionalProperties": false
},
"items": {
"type": [
"array",
"null"
],
"items": {
"type": "object",
"properties": {}
}
},
"options": {
"type": [
"array",
"null"
],
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"position": {
"type": "number"
},
"value": {
"type": "string"
},
"is_active": {
"type": "boolean"
}
},
"required": [
"id",
"name",
"position",
"value",
"is_active"
]
},
"description": "List of options with possible (allowed) values."
},
"settings": {
"type": "array",
"items": {
"type": "string"
},
"description": "Common field settings"
}
},
"required": [
"id",
"name",
"position",
"alias",
"has_unique_data",
"has_value",
"removable",
"is_active",
"list",
"read_only",
"required"
]
}
},
"options": {
"type": [
"array",
"null"
],
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"position": {
"type": "number"
},
"value": {
"type": "string"
},
"is_active": {
"type": "boolean"
}
},
"required": [
"id",
"name",
"position",
"value",
"is_active"
]
},
"description": "List of options with possible (allowed) values."
},
"settings": {
"type": "array",
"items": {
"type": "string"
},
"description": "Common field settings"
},
"is_locked": {
"type": "boolean"
},
"value_details": {
"type": "array"
},
"values_count": {
"type": "number"
},
"assignment_settings": {
"type": "array"
},
"access_permissions": {
"type": "object",
"properties": {
"history": {
"type": "boolean"
},
"view": {
"type": "boolean"
},
"edit": {
"type": "boolean"
}
},
"required": [
"history",
"view",
"edit"
]
},
"assignment_permissions": {
"type": "object",
"properties": {
"permissions": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
}
},
"required": [
"id",
"name",
"alias"
]
},
"access_list": {
"type": "array",
"description": "user, manager, hr"
}
},
"required": [
"permissions",
"access_list"
]
}
},
"required": [
"id",
"name",
"position",
"alias",
"has_unique_data",
"has_value",
"removable",
"is_active",
"list",
"read_only",
"required",
"is_locked",
"value_details",
"values_count",
"assignment_settings",
"access_permissions",
"assignment_permissions"
]
}
},
"required": [
"id"
]
}
},
"required": [
"summary",
"pso"
]
}
}
}401Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 401
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}403Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 403
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}404Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 404
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}406Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 406
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}422Headers
Content-Type: application/jsonBody
{
"message": "Descriptive error message",
"status_code": 422,
"errors": [
"Error message"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
},
"errors": {
"type": "array"
}
}
}500Headers
Content-Type: application/jsonBody
{
"message": "Internal Error",
"status_code": 500
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}FieldsGET/psos/fields{?name,active,category,privacy-level,pso-type,data-type,append-profile,target-pso-type,sort-by,sort-direction}
Fetch fields for specified user profile
Example URI
- name
string(optional) Example: Field Namefilter by field name
- active
boolean(required) Example: truefilter by field activity
- category
string(optional) Example: identityfilter by field category
- privacy-level
array[string](optional) Example: publicfilter by field privacy level
- pso-type
string(optional) Example: usrfilter by field pso type
- data-type
array[string](optional) Example: compositefilter by fields data type
- append-profile
boolean(optional) Example: trueif pso-type query param is declared, retrieve only fields which are belong to this pso type profile
- target-pso-type
string(optional) Example: usrretrieve fields with corresponded target_pso_type setting
- sort-by
name,pso-type,data-type,category,privacy-level,active(optional) Example: name- sort-direction
asc, desc(optional) Example: asc
Headers
Accept: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target permission>200Headers
Content-Type: application/jsonBody
{
"data": [
{
"id": 1,
"name": "Field Name",
"position": 5,
"alias": "usr_first_name",
"has_unique_data": false,
"has_value": true,
"removable": false,
"is_active": true,
"list": false,
"read_only": false,
"required": true,
"type": {
"id": 1,
"name": "Data Type Name",
"alias": "data_type_alias",
"settings": [
{
"id": 1,
"name": "Data Type Setting Name",
"alias": "data_type_setting_alias",
"is_required": true
}
],
"supports_collection": false,
"supports_read_only": false,
"supports_unique": false
},
"category": {
"id": 32,
"alias": "usr_identity",
"position": 5,
"system_required": true,
"name": "Identity",
"description": "...",
"is_active": true,
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
}
},
"domains": [
{
"id": 46,
"alias": "usr_global",
"name": "User Global",
"description": "...",
"is_editable": false,
"is_removable": false,
"is_active": true,
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
}
}
],
"privacy_level": {
"id": 123,
"alias": "public",
"name": "Not Sensitive",
"level": 100
},
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
},
"items": [
{
"id": 1,
"name": "Field Name",
"position": 5,
"alias": "usr_first_name",
"has_unique_data": false,
"has_value": true,
"removable": false,
"is_active": true,
"list": false,
"read_only": false,
"required": true,
"type": {
"id": 1,
"name": "Data Type Name",
"alias": "data_type_alias",
"settings": [
{
"id": 1,
"name": "Data Type Setting Name",
"alias": "data_type_setting_alias",
"is_required": true
}
],
"supports_collection": false,
"supports_read_only": false,
"supports_unique": false
},
"category": {
"id": 32,
"alias": "usr_identity",
"position": 5,
"system_required": true,
"name": "Identity",
"description": "...",
"is_active": true,
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
}
},
"domains": [
{
"id": 46,
"alias": "usr_global",
"name": "User Global",
"description": "...",
"is_editable": false,
"is_removable": false,
"is_active": true,
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
}
}
],
"privacy_level": {
"id": 123,
"alias": "public",
"name": "Not Sensitive",
"level": 100
},
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
},
"items": [
{}
],
"options": [
{
"id": 198,
"name": "Chose me!",
"position": 9,
"value": "198",
"is_active": true
}
],
"settings": []
}
],
"options": [
{
"id": 198,
"name": "Chose me!",
"position": 9,
"value": "198",
"is_active": true
}
],
"settings": [],
"is_locked": false,
"value_details": [
"value1",
"value2"
],
"values_count": 2,
"assignment_settings": [
{
"setting": "public",
"value": "1"
}
],
"access_permissions": {
"history": true,
"view": true,
"edit": true
},
"assignment_permissions": {
"permissions": {
"id": 1,
"name": "View",
"alias": "view"
},
"access_list": [
"0",
"1",
"1"
]
}
}
],
"meta": {
"pagination": {
"total": 238,
"count": 25,
"per_page": 25,
"current_page": 2,
"total_pages": 10,
"links": {
"previous": "http://example.com/api/<endpoint>?page=1",
"next": "http://example.com/api/<endpoint>?page=3"
}
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "array"
},
"meta": {
"type": "object",
"properties": {
"pagination": {
"type": "object",
"properties": {
"total": {
"type": "number"
},
"count": {
"type": "number"
},
"per_page": {
"type": "number"
},
"current_page": {
"type": "number"
},
"total_pages": {
"type": "number"
},
"links": {
"type": "object",
"properties": {
"previous": {
"type": "string"
},
"next": {
"type": "string"
}
},
"required": [
"previous",
"next"
]
}
},
"required": [
"total",
"count",
"per_page",
"current_page",
"total_pages",
"links"
],
"additionalProperties": false
}
},
"required": [
"pagination"
]
}
}
}401Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 401
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}403Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 403
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}404Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 404
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}406Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 406
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}422Headers
Content-Type: application/jsonBody
{
"message": "Descriptive error message",
"status_code": 422,
"errors": [
"Error message"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
},
"errors": {
"type": "array"
}
}
}500Headers
Content-Type: application/jsonBody
{
"message": "Internal Error",
"status_code": 500
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}StatusPOST/psos/{pso}/status
Update status for specified pso
Example URI
- pso
integer(required) Example: 1id of the pso
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>Body
{
"status": "default",
"active": true
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"default",
"on_leave",
"on_remote",
"at_the_office"
]
},
"active": {
"type": "boolean"
}
},
"required": [
"status",
"active"
]
}202Headers
Content-Type: application/json400Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 400
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}401Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 401
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}403Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 403
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}404Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 404
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}406Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 406
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}422Headers
Content-Type: application/jsonBody
{
"message": "Descriptive error message",
"status_code": 422,
"errors": [
"Error message"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
},
"errors": {
"type": "array"
}
}
}500Headers
Content-Type: application/jsonBody
{
"message": "Internal Error",
"status_code": 500
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}Pso Types ¶
Resources ¶
Resources is a group of instances which is related to the main system entities. It’s not possible to create new of them or modify existing.
Resources ¶
Action TypesGET/resources/action-types{?page,per-page,no-pagination}
Get list of action types
Example URI
- page
number(required) Example: 1Page number.
1by default- per-page
number(required) Example: 10Number of items per page,
25by default- no-pagination
boolean(required) Example: falseif presented and positive pagination will not be applied. All available items will be returned.
Note: it may have significant impact on the performance
Note: once this option positive and presented -
metaattribute with pagination data will be omit in response
Headers
Accept: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target permission>200Headers
Content-Type: application/jsonBody
{
"data": [
{
"id": 1,
"alias": "action_type_alias",
"name": "Action Type Name",
"category": "action_type_category_alias"
}
],
"meta": {
"pagination": {
"total": 238,
"count": 25,
"per_page": 25,
"current_page": 2,
"total_pages": 10,
"links": {
"previous": "http://example.com/api/<endpoint>?page=1",
"next": "http://example.com/api/<endpoint>?page=3"
}
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"alias": {
"type": "string"
},
"name": {
"type": "string"
},
"category": {
"type": [
"string",
"null"
]
}
},
"required": [
"id",
"alias",
"name"
]
}
},
"meta": {
"type": "object",
"properties": {
"pagination": {
"type": "object",
"properties": {
"total": {
"type": "number"
},
"count": {
"type": "number"
},
"per_page": {
"type": "number"
},
"current_page": {
"type": "number"
},
"total_pages": {
"type": "number"
},
"links": {
"type": "object",
"properties": {
"previous": {
"type": "string"
},
"next": {
"type": "string"
}
},
"required": [
"previous",
"next"
]
}
},
"required": [
"total",
"count",
"per_page",
"current_page",
"total_pages",
"links"
],
"additionalProperties": false
}
},
"required": [
"pagination"
]
}
}
}401Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 401
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}403Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 403
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}404Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 404
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}406Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 406
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}422Headers
Content-Type: application/jsonBody
{
"message": "Descriptive error message",
"status_code": 422,
"errors": [
"Error message"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
},
"errors": {
"type": "array"
}
}
}500Headers
Content-Type: application/jsonBody
{
"message": "Internal Error",
"status_code": 500
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}Data TypesGET/resources/data-types{?page,per-page,no-pagination}
Get list of data types
Example URI
- page
number(required) Example: 1Page number.
1by default- per-page
number(required) Example: 10Number of items per page,
25by default- no-pagination
boolean(required) Example: falseif presented and positive pagination will not be applied. All available items will be returned.
Note: it may have significant impact on the performance
Note: once this option positive and presented -
metaattribute with pagination data will be omit in response
Headers
Accept: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target permission>200Headers
Content-Type: application/jsonBody
{
"data": [
{
"id": 1,
"name": "Data Type Name",
"alias": "data_type_alias",
"settings": [
{
"id": 1,
"name": "Data Type Setting Name",
"alias": "data_type_setting_alias",
"is_required": true
}
],
"supports_collection": false,
"supports_read_only": false,
"supports_unique": false
}
],
"meta": {
"pagination": {
"total": 238,
"count": 25,
"per_page": 25,
"current_page": 2,
"total_pages": 10,
"links": {
"previous": "http://example.com/api/<endpoint>?page=1",
"next": "http://example.com/api/<endpoint>?page=3"
}
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"settings": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"is_required": {
"type": "boolean"
}
},
"required": [
"id",
"name",
"alias",
"is_required"
]
}
},
"supports_collection": {
"type": "boolean"
},
"supports_read_only": {
"type": "boolean"
},
"supports_unique": {
"type": "boolean"
}
},
"required": [
"id",
"name",
"alias",
"supports_collection",
"supports_read_only",
"supports_unique"
]
}
},
"meta": {
"type": "object",
"properties": {
"pagination": {
"type": "object",
"properties": {
"total": {
"type": "number"
},
"count": {
"type": "number"
},
"per_page": {
"type": "number"
},
"current_page": {
"type": "number"
},
"total_pages": {
"type": "number"
},
"links": {
"type": "object",
"properties": {
"previous": {
"type": "string"
},
"next": {
"type": "string"
}
},
"required": [
"previous",
"next"
]
}
},
"required": [
"total",
"count",
"per_page",
"current_page",
"total_pages",
"links"
],
"additionalProperties": false
}
},
"required": [
"pagination"
]
}
}
}401Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 401
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}403Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 403
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}404Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 404
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}406Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 406
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}422Headers
Content-Type: application/jsonBody
{
"message": "Descriptive error message",
"status_code": 422,
"errors": [
"Error message"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
},
"errors": {
"type": "array"
}
}
}500Headers
Content-Type: application/jsonBody
{
"message": "Internal Error",
"status_code": 500
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}Field CategoriesGET/resources/field-categories{?page,per-page,no-pagination}
Get list of field categories
Example URI
- page
number(required) Example: 1Page number.
1by default- per-page
number(required) Example: 10Number of items per page,
25by default- no-pagination
boolean(required) Example: falseif presented and positive pagination will not be applied. All available items will be returned.
Note: it may have significant impact on the performance
Note: once this option positive and presented -
metaattribute with pagination data will be omit in response
Headers
Accept: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target permission>200Headers
Content-Type: application/jsonBody
{
"data": [
{
"id": 1,
"alias": "field_category_alias",
"name": "Field Category Name",
"position": 1,
"system_required": false,
"description": "Field Category Description",
"is_active": true,
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
}
}
],
"meta": {
"pagination": {
"total": 238,
"count": 25,
"per_page": 25,
"current_page": 2,
"total_pages": 10,
"links": {
"previous": "http://example.com/api/<endpoint>?page=1",
"next": "http://example.com/api/<endpoint>?page=3"
}
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"alias": {
"type": "string"
},
"name": {
"type": "string"
},
"position": {
"type": "number"
},
"system_required": {
"type": "boolean"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"pso_type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"system_required": {
"type": "boolean"
},
"creation_form_instance_id": {
"type": "number"
},
"profile_form_instance_id": {
"type": "number"
}
},
"required": [
"id",
"name",
"alias",
"description",
"is_active",
"system_required",
"creation_form_instance_id",
"profile_form_instance_id"
]
}
},
"required": [
"id",
"alias",
"name",
"position",
"system_required",
"description",
"is_active"
]
}
},
"meta": {
"type": "object",
"properties": {
"pagination": {
"type": "object",
"properties": {
"total": {
"type": "number"
},
"count": {
"type": "number"
},
"per_page": {
"type": "number"
},
"current_page": {
"type": "number"
},
"total_pages": {
"type": "number"
},
"links": {
"type": "object",
"properties": {
"previous": {
"type": "string"
},
"next": {
"type": "string"
}
},
"required": [
"previous",
"next"
]
}
},
"required": [
"total",
"count",
"per_page",
"current_page",
"total_pages",
"links"
],
"additionalProperties": false
}
},
"required": [
"pagination"
]
}
}
}401Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 401
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}403Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 403
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}404Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 404
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}406Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 406
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}422Headers
Content-Type: application/jsonBody
{
"message": "Descriptive error message",
"status_code": 422,
"errors": [
"Error message"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
},
"errors": {
"type": "array"
}
}
}500Headers
Content-Type: application/jsonBody
{
"message": "Internal Error",
"status_code": 500
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}Field PermissionsGET/resources/field-permissions{?page,per-page,no-pagination}
Get list of field permissions
Example URI
- page
number(required) Example: 1Page number.
1by default- per-page
number(required) Example: 10Number of items per page,
25by default- no-pagination
boolean(required) Example: falseif presented and positive pagination will not be applied. All available items will be returned.
Note: it may have significant impact on the performance
Note: once this option positive and presented -
metaattribute with pagination data will be omit in response
Headers
Accept: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target permission>200Headers
Content-Type: application/jsonBody
{
"data": [
{
"id": 1,
"alias": "field_permission_alias",
"name": "Field Permission Name"
}
],
"meta": {
"pagination": {
"total": 238,
"count": 25,
"per_page": 25,
"current_page": 2,
"total_pages": 10,
"links": {
"previous": "http://example.com/api/<endpoint>?page=1",
"next": "http://example.com/api/<endpoint>?page=3"
}
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"alias": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"id",
"alias",
"name"
]
}
},
"meta": {
"type": "object",
"properties": {
"pagination": {
"type": "object",
"properties": {
"total": {
"type": "number"
},
"count": {
"type": "number"
},
"per_page": {
"type": "number"
},
"current_page": {
"type": "number"
},
"total_pages": {
"type": "number"
},
"links": {
"type": "object",
"properties": {
"previous": {
"type": "string"
},
"next": {
"type": "string"
}
},
"required": [
"previous",
"next"
]
}
},
"required": [
"total",
"count",
"per_page",
"current_page",
"total_pages",
"links"
],
"additionalProperties": false
}
},
"required": [
"pagination"
]
}
}
}401Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 401
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}403Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 403
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}404Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 404
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}406Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 406
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}422Headers
Content-Type: application/jsonBody
{
"message": "Descriptive error message",
"status_code": 422,
"errors": [
"Error message"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
},
"errors": {
"type": "array"
}
}
}500Headers
Content-Type: application/jsonBody
{
"message": "Internal Error",
"status_code": 500
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}History ActionsGET/resources/history-actions{?page,per-page,no-pagination}
Get list of history actions
Example URI
- page
number(required) Example: 1Page number.
1by default- per-page
number(required) Example: 10Number of items per page,
25by default- no-pagination
boolean(required) Example: falseif presented and positive pagination will not be applied. All available items will be returned.
Note: it may have significant impact on the performance
Note: once this option positive and presented -
metaattribute with pagination data will be omit in response
Headers
Accept: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target permission>200Headers
Content-Type: application/jsonBody
{
"data": [
{
"id": 1,
"alias": "history_action_alias",
"name": "History Action Name"
}
],
"meta": {
"pagination": {
"total": 238,
"count": 25,
"per_page": 25,
"current_page": 2,
"total_pages": 10,
"links": {
"previous": "http://example.com/api/<endpoint>?page=1",
"next": "http://example.com/api/<endpoint>?page=3"
}
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"alias": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"id",
"alias",
"name"
]
}
},
"meta": {
"type": "object",
"properties": {
"pagination": {
"type": "object",
"properties": {
"total": {
"type": "number"
},
"count": {
"type": "number"
},
"per_page": {
"type": "number"
},
"current_page": {
"type": "number"
},
"total_pages": {
"type": "number"
},
"links": {
"type": "object",
"properties": {
"previous": {
"type": "string"
},
"next": {
"type": "string"
}
},
"required": [
"previous",
"next"
]
}
},
"required": [
"total",
"count",
"per_page",
"current_page",
"total_pages",
"links"
],
"additionalProperties": false
}
},
"required": [
"pagination"
]
}
}
}401Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 401
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}403Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 403
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}404Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 404
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}406Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 406
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}422Headers
Content-Type: application/jsonBody
{
"message": "Descriptive error message",
"status_code": 422,
"errors": [
"Error message"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
},
"errors": {
"type": "array"
}
}
}500Headers
Content-Type: application/jsonBody
{
"message": "Internal Error",
"status_code": 500
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}Idea CategoriesGET/resources/idea-categories{?page,per-page,no-pagination}
Get list of idea categories
Example URI
- page
number(required) Example: 1Page number.
1by default- per-page
number(required) Example: 10Number of items per page,
25by default- no-pagination
boolean(required) Example: falseif presented and positive pagination will not be applied. All available items will be returned.
Note: it may have significant impact on the performance
Note: once this option positive and presented -
metaattribute with pagination data will be omit in response
Headers
Accept: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target permission>200Headers
Content-Type: application/jsonBody
{
"data": [
{
"id": 1,
"alias": "idea_category_alias",
"name": "Idea Category Name"
}
],
"meta": {
"pagination": {
"total": 238,
"count": 25,
"per_page": 25,
"current_page": 2,
"total_pages": 10,
"links": {
"previous": "http://example.com/api/<endpoint>?page=1",
"next": "http://example.com/api/<endpoint>?page=3"
}
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"alias": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"id",
"alias",
"name"
]
}
},
"meta": {
"type": "object",
"properties": {
"pagination": {
"type": "object",
"properties": {
"total": {
"type": "number"
},
"count": {
"type": "number"
},
"per_page": {
"type": "number"
},
"current_page": {
"type": "number"
},
"total_pages": {
"type": "number"
},
"links": {
"type": "object",
"properties": {
"previous": {
"type": "string"
},
"next": {
"type": "string"
}
},
"required": [
"previous",
"next"
]
}
},
"required": [
"total",
"count",
"per_page",
"current_page",
"total_pages",
"links"
],
"additionalProperties": false
}
},
"required": [
"pagination"
]
}
}
}401Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 401
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}403Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 403
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}404Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 404
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}406Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 406
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}422Headers
Content-Type: application/jsonBody
{
"message": "Descriptive error message",
"status_code": 422,
"errors": [
"Error message"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
},
"errors": {
"type": "array"
}
}
}500Headers
Content-Type: application/jsonBody
{
"message": "Internal Error",
"status_code": 500
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}Idea StatusesGET/resources/idea-statuses{?page,per-page,no-pagination}
Get list of idea statuses
Example URI
- page
number(required) Example: 1Page number.
1by default- per-page
number(required) Example: 10Number of items per page,
25by default- no-pagination
boolean(required) Example: falseif presented and positive pagination will not be applied. All available items will be returned.
Note: it may have significant impact on the performance
Note: once this option positive and presented -
metaattribute with pagination data will be omit in response
Headers
Accept: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target permission>200Headers
Content-Type: application/jsonBody
{
"data": [
{
"id": 1,
"alias": "idea_status_alias",
"name": "Idea Status Name"
}
],
"meta": {
"pagination": {
"total": 238,
"count": 25,
"per_page": 25,
"current_page": 2,
"total_pages": 10,
"links": {
"previous": "http://example.com/api/<endpoint>?page=1",
"next": "http://example.com/api/<endpoint>?page=3"
}
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"alias": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"id",
"alias",
"name"
]
}
},
"meta": {
"type": "object",
"properties": {
"pagination": {
"type": "object",
"properties": {
"total": {
"type": "number"
},
"count": {
"type": "number"
},
"per_page": {
"type": "number"
},
"current_page": {
"type": "number"
},
"total_pages": {
"type": "number"
},
"links": {
"type": "object",
"properties": {
"previous": {
"type": "string"
},
"next": {
"type": "string"
}
},
"required": [
"previous",
"next"
]
}
},
"required": [
"total",
"count",
"per_page",
"current_page",
"total_pages",
"links"
],
"additionalProperties": false
}
},
"required": [
"pagination"
]
}
}
}401Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 401
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}403Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 403
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}404Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 404
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}406Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 406
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}422Headers
Content-Type: application/jsonBody
{
"message": "Descriptive error message",
"status_code": 422,
"errors": [
"Error message"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
},
"errors": {
"type": "array"
}
}
}500Headers
Content-Type: application/jsonBody
{
"message": "Internal Error",
"status_code": 500
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}News TypesGET/resources/news-types{?page,per-page,no-pagination}
Get list of news types
Example URI
- page
number(required) Example: 1Page number.
1by default- per-page
number(required) Example: 10Number of items per page,
25by default- no-pagination
boolean(required) Example: falseif presented and positive pagination will not be applied. All available items will be returned.
Note: it may have significant impact on the performance
Note: once this option positive and presented -
metaattribute with pagination data will be omit in response
Headers
Accept: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target permission>200Headers
Content-Type: application/jsonBody
{
"data": [
{
"id": 1,
"alias": "news_type_alias",
"name": "News Type Name"
}
],
"meta": {
"pagination": {
"total": 238,
"count": 25,
"per_page": 25,
"current_page": 2,
"total_pages": 10,
"links": {
"previous": "http://example.com/api/<endpoint>?page=1",
"next": "http://example.com/api/<endpoint>?page=3"
}
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"alias": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"id",
"alias",
"name"
]
}
},
"meta": {
"type": "object",
"properties": {
"pagination": {
"type": "object",
"properties": {
"total": {
"type": "number"
},
"count": {
"type": "number"
},
"per_page": {
"type": "number"
},
"current_page": {
"type": "number"
},
"total_pages": {
"type": "number"
},
"links": {
"type": "object",
"properties": {
"previous": {
"type": "string"
},
"next": {
"type": "string"
}
},
"required": [
"previous",
"next"
]
}
},
"required": [
"total",
"count",
"per_page",
"current_page",
"total_pages",
"links"
],
"additionalProperties": false
}
},
"required": [
"pagination"
]
}
}
}401Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 401
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}403Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 403
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}404Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 404
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}406Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 406
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}422Headers
Content-Type: application/jsonBody
{
"message": "Descriptive error message",
"status_code": 422,
"errors": [
"Error message"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
},
"errors": {
"type": "array"
}
}
}500Headers
Content-Type: application/jsonBody
{
"message": "Internal Error",
"status_code": 500
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}Notification TypesGET/resources/notification-types{?page,per-page,no-pagination}
Get list of notification types
Example URI
- page
number(required) Example: 1Page number.
1by default- per-page
number(required) Example: 10Number of items per page,
25by default- no-pagination
boolean(required) Example: falseif presented and positive pagination will not be applied. All available items will be returned.
Note: it may have significant impact on the performance
Note: once this option positive and presented -
metaattribute with pagination data will be omit in response
Headers
Accept: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target permission>200Headers
Content-Type: application/jsonBody
{
"data": [
{
"id": 1,
"alias": "notification_type_alias",
"name": "Notification Type Name"
}
],
"meta": {
"pagination": {
"total": 238,
"count": 25,
"per_page": 25,
"current_page": 2,
"total_pages": 10,
"links": {
"previous": "http://example.com/api/<endpoint>?page=1",
"next": "http://example.com/api/<endpoint>?page=3"
}
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"alias": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"id",
"alias",
"name"
]
}
},
"meta": {
"type": "object",
"properties": {
"pagination": {
"type": "object",
"properties": {
"total": {
"type": "number"
},
"count": {
"type": "number"
},
"per_page": {
"type": "number"
},
"current_page": {
"type": "number"
},
"total_pages": {
"type": "number"
},
"links": {
"type": "object",
"properties": {
"previous": {
"type": "string"
},
"next": {
"type": "string"
}
},
"required": [
"previous",
"next"
]
}
},
"required": [
"total",
"count",
"per_page",
"current_page",
"total_pages",
"links"
],
"additionalProperties": false
}
},
"required": [
"pagination"
]
}
}
}401Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 401
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}403Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 403
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}404Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 404
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}406Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 406
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}422Headers
Content-Type: application/jsonBody
{
"message": "Descriptive error message",
"status_code": 422,
"errors": [
"Error message"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
},
"errors": {
"type": "array"
}
}
}500Headers
Content-Type: application/jsonBody
{
"message": "Internal Error",
"status_code": 500
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}FeaturesGET/resources/features{?page,per-page,no-pagination}
Get list of features
Example URI
- page
number(required) Example: 1Page number.
1by default- per-page
number(required) Example: 10Number of items per page,
25by default- no-pagination
boolean(required) Example: falseif presented and positive pagination will not be applied. All available items will be returned.
Note: it may have significant impact on the performance
Note: once this option positive and presented -
metaattribute with pagination data will be omit in response
Headers
Accept: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target permission>200Headers
Content-Type: application/jsonBody
{
"data": [
{
"id": 1,
"alias": "feature_alias",
"name": "Feature Name"
}
],
"meta": {
"pagination": {
"total": 238,
"count": 25,
"per_page": 25,
"current_page": 2,
"total_pages": 10,
"links": {
"previous": "http://example.com/api/<endpoint>?page=1",
"next": "http://example.com/api/<endpoint>?page=3"
}
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"alias": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"id",
"alias",
"name"
]
}
},
"meta": {
"type": "object",
"properties": {
"pagination": {
"type": "object",
"properties": {
"total": {
"type": "number"
},
"count": {
"type": "number"
},
"per_page": {
"type": "number"
},
"current_page": {
"type": "number"
},
"total_pages": {
"type": "number"
},
"links": {
"type": "object",
"properties": {
"previous": {
"type": "string"
},
"next": {
"type": "string"
}
},
"required": [
"previous",
"next"
]
}
},
"required": [
"total",
"count",
"per_page",
"current_page",
"total_pages",
"links"
],
"additionalProperties": false
}
},
"required": [
"pagination"
]
}
}
}401Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 401
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}403Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 403
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}404Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 404
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}406Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 406
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}422Headers
Content-Type: application/jsonBody
{
"message": "Descriptive error message",
"status_code": 422,
"errors": [
"Error message"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
},
"errors": {
"type": "array"
}
}
}500Headers
Content-Type: application/jsonBody
{
"message": "Internal Error",
"status_code": 500
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}Population TypesGET/resources/population-types{?page,per-page,no-pagination}
Get list of population types
Example URI
- page
number(required) Example: 1Page number.
1by default- per-page
number(required) Example: 10Number of items per page,
25by default- no-pagination
boolean(required) Example: falseif presented and positive pagination will not be applied. All available items will be returned.
Note: it may have significant impact on the performance
Note: once this option positive and presented -
metaattribute with pagination data will be omit in response
Headers
Accept: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target permission>200Headers
Content-Type: application/jsonBody
{
"data": [
{
"id": 1,
"alias": "population_type_alias",
"name": "Population Type Name"
}
],
"meta": {
"pagination": {
"total": 238,
"count": 25,
"per_page": 25,
"current_page": 2,
"total_pages": 10,
"links": {
"previous": "http://example.com/api/<endpoint>?page=1",
"next": "http://example.com/api/<endpoint>?page=3"
}
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"alias": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"id",
"alias",
"name"
]
}
},
"meta": {
"type": "object",
"properties": {
"pagination": {
"type": "object",
"properties": {
"total": {
"type": "number"
},
"count": {
"type": "number"
},
"per_page": {
"type": "number"
},
"current_page": {
"type": "number"
},
"total_pages": {
"type": "number"
},
"links": {
"type": "object",
"properties": {
"previous": {
"type": "string"
},
"next": {
"type": "string"
}
},
"required": [
"previous",
"next"
]
}
},
"required": [
"total",
"count",
"per_page",
"current_page",
"total_pages",
"links"
],
"additionalProperties": false
}
},
"required": [
"pagination"
]
}
}
}401Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 401
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}403Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 403
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}404Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 404
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}406Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 406
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}422Headers
Content-Type: application/jsonBody
{
"message": "Descriptive error message",
"status_code": 422,
"errors": [
"Error message"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
},
"errors": {
"type": "array"
}
}
}500Headers
Content-Type: application/jsonBody
{
"message": "Internal Error",
"status_code": 500
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}Privacy LevelsGET/resources/privacy-levels{?page,per-page,no-pagination}
Get list of privacy levels
Example URI
- page
number(required) Example: 1Page number.
1by default- per-page
number(required) Example: 10Number of items per page,
25by default- no-pagination
boolean(required) Example: falseif presented and positive pagination will not be applied. All available items will be returned.
Note: it may have significant impact on the performance
Note: once this option positive and presented -
metaattribute with pagination data will be omit in response
Headers
Accept: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target permission>200Headers
Content-Type: application/jsonBody
{
"data": [
{
"id": 1,
"alias": "privacy_level_alias",
"name": "Privacy Level Name",
"level": 500
}
],
"meta": {
"pagination": {
"total": 238,
"count": 25,
"per_page": 25,
"current_page": 2,
"total_pages": 10,
"links": {
"previous": "http://example.com/api/<endpoint>?page=1",
"next": "http://example.com/api/<endpoint>?page=3"
}
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"alias": {
"type": "string"
},
"name": {
"type": "string"
},
"level": {
"type": "number"
}
},
"required": [
"id",
"alias",
"name",
"level"
]
}
},
"meta": {
"type": "object",
"properties": {
"pagination": {
"type": "object",
"properties": {
"total": {
"type": "number"
},
"count": {
"type": "number"
},
"per_page": {
"type": "number"
},
"current_page": {
"type": "number"
},
"total_pages": {
"type": "number"
},
"links": {
"type": "object",
"properties": {
"previous": {
"type": "string"
},
"next": {
"type": "string"
}
},
"required": [
"previous",
"next"
]
}
},
"required": [
"total",
"count",
"per_page",
"current_page",
"total_pages",
"links"
],
"additionalProperties": false
}
},
"required": [
"pagination"
]
}
}
}401Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 401
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}403Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 403
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}404Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 404
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}406Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 406
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}422Headers
Content-Type: application/jsonBody
{
"message": "Descriptive error message",
"status_code": 422,
"errors": [
"Error message"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
},
"errors": {
"type": "array"
}
}
}500Headers
Content-Type: application/jsonBody
{
"message": "Internal Error",
"status_code": 500
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}SettingsGET/resources/settings{?page,per-page,no-pagination}
Get list of settings
Example URI
- page
number(required) Example: 1Page number.
1by default- per-page
number(required) Example: 10Number of items per page,
25by default- no-pagination
boolean(required) Example: falseif presented and positive pagination will not be applied. All available items will be returned.
Note: it may have significant impact on the performance
Note: once this option positive and presented -
metaattribute with pagination data will be omit in response
Headers
Accept: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target permission>200Headers
Content-Type: application/jsonBody
{
"data": [
{
"id": 1,
"alias": "setting_alias",
"name": "Setting Name"
}
],
"meta": {
"pagination": {
"total": 238,
"count": 25,
"per_page": 25,
"current_page": 2,
"total_pages": 10,
"links": {
"previous": "http://example.com/api/<endpoint>?page=1",
"next": "http://example.com/api/<endpoint>?page=3"
}
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"alias": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"id",
"alias",
"name"
]
}
},
"meta": {
"type": "object",
"properties": {
"pagination": {
"type": "object",
"properties": {
"total": {
"type": "number"
},
"count": {
"type": "number"
},
"per_page": {
"type": "number"
},
"current_page": {
"type": "number"
},
"total_pages": {
"type": "number"
},
"links": {
"type": "object",
"properties": {
"previous": {
"type": "string"
},
"next": {
"type": "string"
}
},
"required": [
"previous",
"next"
]
}
},
"required": [
"total",
"count",
"per_page",
"current_page",
"total_pages",
"links"
],
"additionalProperties": false
}
},
"required": [
"pagination"
]
}
}
}401Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 401
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}403Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 403
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}404Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 404
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}406Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 406
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}422Headers
Content-Type: application/jsonBody
{
"message": "Descriptive error message",
"status_code": 422,
"errors": [
"Error message"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
},
"errors": {
"type": "array"
}
}
}500Headers
Content-Type: application/jsonBody
{
"message": "Internal Error",
"status_code": 500
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}Roles ¶
Roles provide users with access permissions (features) to different parts of system. Also roles determines modules access.
Management permissions
-
roles.view- ability to view single and list of roles -
roles.create- ability to create new roles in system -
roles.edit- ability to edit existing in system roles -
roles.delete- ability to remove existing in system roles
Roles ¶
Common ListGET/roles{?name,active,pso-type,include,sort-by,sort-direction,page,per-page,no-pagination}
Get list of roles matches specified filters
Example URI
- name
string(optional) Example: name of role to search by- active
boolean(optional) Example: true- pso-type
string(optional) Example: usr- include
string(optional) Example: modules,featuresThe way to include relations in the response. Target relations can be comma separated if you want to get few of them
- sort-by
name, pso-type, relation, privacy-level, status(required) Example: name- sort-direction
asc, desc(required) Example: asc- page
number(required) Example: 1Page number.
1by default- per-page
number(required) Example: 10Number of items per page,
25by default- no-pagination
boolean(required) Example: falseif presented and positive pagination will not be applied. All available items will be returned.
Note: it may have significant impact on the performance
Note: once this option positive and presented -
metaattribute with pagination data will be omit in response
Headers
Accept: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target permission>200Headers
Content-Type: application/jsonBody
{
"data": [
{
"id": 1,
"alias": "role_alias",
"name": "Role Name",
"description": "Role Description",
"is_active": true,
"status": "ok",
"assignment_mode": "role_driven",
"permissions": {
"can_edit": true,
"can_delete": true
},
"relation_type": {
"alias": "relation_alias",
"name": "Relation Name"
},
"relation_field": {
"id": 1,
"name": "Field Name",
"position": 5,
"alias": "usr_first_name",
"has_unique_data": false,
"has_value": true,
"removable": false,
"is_active": true,
"list": false,
"read_only": false,
"required": true,
"type": {
"id": 1,
"name": "Data Type Name",
"alias": "data_type_alias",
"settings": [
{
"id": 1,
"name": "Data Type Setting Name",
"alias": "data_type_setting_alias",
"is_required": true
}
],
"supports_collection": false,
"supports_read_only": false,
"supports_unique": false
},
"category": {
"id": 32,
"alias": "usr_identity",
"position": 5,
"system_required": true,
"name": "Identity",
"description": "...",
"is_active": true,
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
}
},
"domains": [
{
"id": 46,
"alias": "usr_global",
"name": "User Global",
"description": "...",
"is_editable": false,
"is_removable": false,
"is_active": true,
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
}
}
],
"privacy_level": {
"id": 123,
"alias": "public",
"name": "Not Sensitive",
"level": 100
},
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
},
"items": [
{}
],
"options": [
{
"id": 198,
"name": "Chose me!",
"position": 9,
"value": "198",
"is_active": true
}
],
"settings": []
},
"assignment_rules": [
{
"assignee": {
"type": "all",
"details": {}
},
"population": {
"type": "all",
"details": {}
}
}
],
"field_access_rules": {
"domains": {
"includes": [
{
"id": 46,
"alias": "usr_global",
"name": "User Global",
"description": "...",
"is_editable": false,
"is_removable": false,
"is_active": true,
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
}
}
],
"excludes": [
{
"id": 46,
"alias": "usr_global",
"name": "User Global",
"description": "...",
"is_editable": false,
"is_removable": false,
"is_active": true,
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
}
}
]
},
"privacy_level": {
"id": 1,
"alias": "privacy_level_alias",
"name": "Privacy Level Name",
"level": 500
}
},
"features": [
{
"id": 1,
"alias": "feature_alias",
"name": "Feature Name"
}
],
"modules": [
{
"id": 1,
"name": "Module name",
"alias": "mdl",
"app_url": {
"android": "http://android/app/url",
"ios": "http://ios/app/url"
},
"store_url": {
"android": "http://android/store/url",
"ios": "http://ios/store/url"
},
"web_url": "http://web/url",
"icon": "http://image.png",
"permissions": [
{
"access": true,
"synchronisation": true
}
]
}
],
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
}
}
],
"meta": {
"pagination": {
"total": 238,
"count": 25,
"per_page": 25,
"current_page": 2,
"total_pages": 10,
"links": {
"previous": "http://example.com/api/<endpoint>?page=1",
"next": "http://example.com/api/<endpoint>?page=3"
}
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"alias": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"status": {
"type": "string",
"enum": [
"ok",
"pending",
"processing",
"conflict",
"failed"
]
},
"assignment_mode": {
"type": "string",
"enum": [
"user_driven",
"role_driven",
"system_driven"
]
},
"permissions": {
"type": "object",
"properties": {
"can_edit": {
"type": "boolean"
},
"can_delete": {
"type": "boolean"
}
},
"required": [
"can_edit",
"can_delete"
]
},
"relation_type": {
"type": "object",
"properties": {
"alias": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"alias",
"name"
]
},
"relation_field": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"position": {
"type": "number"
},
"alias": {
"type": "string"
},
"has_unique_data": {
"type": "boolean",
"description": "whether field requires values to be unique across system"
},
"has_value": {
"type": "boolean",
"description": "whether field has at least one value submitted"
},
"removable": {
"type": "boolean",
"description": "whether field can be removed from system"
},
"is_active": {
"type": "boolean"
},
"list": {
"type": "boolean",
"description": "whether field can handle collection of values"
},
"read_only": {
"type": "boolean",
"description": "whether field value can be changed"
},
"required": {
"type": "boolean",
"description": "whether field value required by system"
},
"type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"settings": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"is_required": {
"type": "boolean"
}
},
"required": [
"id",
"name",
"alias",
"is_required"
]
}
},
"supports_collection": {
"type": "boolean"
},
"supports_read_only": {
"type": "boolean"
},
"supports_unique": {
"type": "boolean"
}
},
"required": [
"id",
"name",
"alias",
"settings",
"supports_collection",
"supports_read_only",
"supports_unique"
],
"additionalProperties": false
},
"category": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"alias": {
"type": "string"
},
"position": {
"type": "number"
},
"system_required": {
"type": "boolean"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"pso_type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"system_required": {
"type": "boolean"
},
"creation_form_instance_id": {
"type": "number"
},
"profile_form_instance_id": {
"type": "number"
}
},
"required": [
"id",
"name",
"alias",
"description",
"is_active",
"system_required",
"creation_form_instance_id",
"profile_form_instance_id"
],
"additionalProperties": false
}
},
"required": [
"id",
"alias",
"position",
"system_required",
"name",
"description",
"is_active"
],
"additionalProperties": false
},
"domains": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"alias": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"is_editable": {
"type": "boolean"
},
"is_removable": {
"type": "boolean"
},
"is_active": {
"type": "boolean"
},
"pso_type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"system_required": {
"type": "boolean"
},
"creation_form_instance_id": {
"type": "number"
},
"profile_form_instance_id": {
"type": "number"
}
},
"required": [
"id",
"name",
"alias",
"description",
"is_active",
"system_required",
"creation_form_instance_id",
"profile_form_instance_id"
],
"additionalProperties": false
}
},
"required": [
"id",
"alias",
"name",
"description",
"is_editable",
"is_removable",
"is_active"
]
}
},
"privacy_level": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"alias": {
"type": "string"
},
"name": {
"type": "string"
},
"level": {
"type": "number"
}
},
"required": [
"id",
"alias",
"name",
"level"
],
"additionalProperties": false
},
"pso_type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"system_required": {
"type": "boolean"
},
"creation_form_instance_id": {
"type": "number"
},
"profile_form_instance_id": {
"type": "number"
}
},
"required": [
"id",
"name",
"alias",
"description",
"is_active",
"system_required",
"creation_form_instance_id",
"profile_form_instance_id"
],
"additionalProperties": false
},
"items": {
"type": [
"array",
"null"
],
"items": {
"type": "object",
"properties": {}
}
},
"options": {
"type": [
"array",
"null"
],
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"position": {
"type": "number"
},
"value": {
"type": "string"
},
"is_active": {
"type": "boolean"
}
},
"required": [
"id",
"name",
"position",
"value",
"is_active"
]
},
"description": "List of options with possible (allowed) values."
},
"settings": {
"type": "array",
"items": {
"type": "string"
},
"description": "Common field settings"
}
},
"required": [
"id",
"name",
"position",
"alias",
"has_unique_data",
"has_value",
"removable",
"is_active",
"list",
"read_only",
"required"
]
},
"assignment_rules": {
"type": "array"
},
"field_access_rules": {
"type": "object",
"properties": {
"domains": {
"type": "object",
"properties": {
"includes": {
"type": "array"
},
"excludes": {
"type": "array"
}
},
"required": [
"includes",
"excludes"
]
},
"privacy_level": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"alias": {
"type": "string"
},
"name": {
"type": "string"
},
"level": {
"type": "number"
}
},
"required": [
"id",
"alias",
"name",
"level"
]
}
},
"required": [
"domains",
"privacy_level"
]
},
"features": {
"type": "array"
},
"modules": {
"type": "array"
},
"pso_type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"system_required": {
"type": "boolean"
},
"creation_form_instance_id": {
"type": "number"
},
"profile_form_instance_id": {
"type": "number"
}
},
"required": [
"id",
"name",
"alias",
"description",
"is_active",
"system_required",
"creation_form_instance_id",
"profile_form_instance_id"
]
}
},
"required": [
"id",
"alias",
"name",
"description",
"is_active",
"status",
"assignment_mode",
"permissions",
"relation_type"
]
}
},
"meta": {
"type": "object",
"properties": {
"pagination": {
"type": "object",
"properties": {
"total": {
"type": "number"
},
"count": {
"type": "number"
},
"per_page": {
"type": "number"
},
"current_page": {
"type": "number"
},
"total_pages": {
"type": "number"
},
"links": {
"type": "object",
"properties": {
"previous": {
"type": "string"
},
"next": {
"type": "string"
}
},
"required": [
"previous",
"next"
]
}
},
"required": [
"total",
"count",
"per_page",
"current_page",
"total_pages",
"links"
],
"additionalProperties": false
}
},
"required": [
"pagination"
]
}
}
}401Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 401
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}403Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 403
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}404Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 404
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}406Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 406
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}422Headers
Content-Type: application/jsonBody
{
"message": "Descriptive error message",
"status_code": 422,
"errors": [
"Error message"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
},
"errors": {
"type": "array"
}
}
}500Headers
Content-Type: application/jsonBody
{
"message": "Internal Error",
"status_code": 500
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}ShowGET/roles/{alias}/{?include}
Get details for selected role
Example URI
- alias
string(required) Example: role_aliasalias of the role
- include
string(optional) Example: modules,featuresThe way to include relations in the response. Target relations can be comma separated if you want to get few of them
Headers
Accept: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target permission>200Headers
Content-Type: application/jsonBody
{
"data": {
"id": 1,
"alias": "role_alias",
"name": "Role Name",
"description": "Role Description",
"is_active": true,
"status": "ok",
"assignment_mode": "role_driven",
"permissions": {
"can_edit": true,
"can_delete": true
},
"relation_type": {
"alias": "relation_alias",
"name": "Relation Name"
},
"relation_field": {
"id": 1,
"name": "Field Name",
"position": 5,
"alias": "usr_first_name",
"has_unique_data": false,
"has_value": true,
"removable": false,
"is_active": true,
"list": false,
"read_only": false,
"required": true,
"type": {
"id": 1,
"name": "Data Type Name",
"alias": "data_type_alias",
"settings": [
{
"id": 1,
"name": "Data Type Setting Name",
"alias": "data_type_setting_alias",
"is_required": true
}
],
"supports_collection": false,
"supports_read_only": false,
"supports_unique": false
},
"category": {
"id": 32,
"alias": "usr_identity",
"position": 5,
"system_required": true,
"name": "Identity",
"description": "...",
"is_active": true,
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
}
},
"domains": [
{
"id": 46,
"alias": "usr_global",
"name": "User Global",
"description": "...",
"is_editable": false,
"is_removable": false,
"is_active": true,
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
}
}
],
"privacy_level": {
"id": 123,
"alias": "public",
"name": "Not Sensitive",
"level": 100
},
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
},
"items": [
{}
],
"options": [
{
"id": 198,
"name": "Chose me!",
"position": 9,
"value": "198",
"is_active": true
}
],
"settings": []
},
"assignment_rules": [
{
"assignee": {
"type": "all",
"details": {}
},
"population": {
"type": "all",
"details": {}
}
}
],
"field_access_rules": {
"domains": {
"includes": [
{
"id": 46,
"alias": "usr_global",
"name": "User Global",
"description": "...",
"is_editable": false,
"is_removable": false,
"is_active": true,
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
}
}
],
"excludes": [
{
"id": 46,
"alias": "usr_global",
"name": "User Global",
"description": "...",
"is_editable": false,
"is_removable": false,
"is_active": true,
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
}
}
]
},
"privacy_level": {
"id": 1,
"alias": "privacy_level_alias",
"name": "Privacy Level Name",
"level": 500
}
},
"features": [
{
"id": 1,
"alias": "feature_alias",
"name": "Feature Name"
}
],
"modules": [
{
"id": 1,
"name": "Module name",
"alias": "mdl",
"app_url": {
"android": "http://android/app/url",
"ios": "http://ios/app/url"
},
"store_url": {
"android": "http://android/store/url",
"ios": "http://ios/store/url"
},
"web_url": "http://web/url",
"icon": "http://image.png",
"permissions": [
{
"access": true,
"synchronisation": true
}
]
}
],
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"alias": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"status": {
"type": "string",
"enum": [
"ok",
"pending",
"processing",
"conflict",
"failed"
]
},
"assignment_mode": {
"type": "string",
"enum": [
"user_driven",
"role_driven",
"system_driven"
]
},
"permissions": {
"type": "object",
"properties": {
"can_edit": {
"type": "boolean"
},
"can_delete": {
"type": "boolean"
}
},
"required": [
"can_edit",
"can_delete"
]
},
"relation_type": {
"type": "object",
"properties": {
"alias": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"alias",
"name"
]
},
"relation_field": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"position": {
"type": "number"
},
"alias": {
"type": "string"
},
"has_unique_data": {
"type": "boolean",
"description": "whether field requires values to be unique across system"
},
"has_value": {
"type": "boolean",
"description": "whether field has at least one value submitted"
},
"removable": {
"type": "boolean",
"description": "whether field can be removed from system"
},
"is_active": {
"type": "boolean"
},
"list": {
"type": "boolean",
"description": "whether field can handle collection of values"
},
"read_only": {
"type": "boolean",
"description": "whether field value can be changed"
},
"required": {
"type": "boolean",
"description": "whether field value required by system"
},
"type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"settings": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"is_required": {
"type": "boolean"
}
},
"required": [
"id",
"name",
"alias",
"is_required"
]
}
},
"supports_collection": {
"type": "boolean"
},
"supports_read_only": {
"type": "boolean"
},
"supports_unique": {
"type": "boolean"
}
},
"required": [
"id",
"name",
"alias",
"settings",
"supports_collection",
"supports_read_only",
"supports_unique"
],
"additionalProperties": false
},
"category": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"alias": {
"type": "string"
},
"position": {
"type": "number"
},
"system_required": {
"type": "boolean"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"pso_type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"system_required": {
"type": "boolean"
},
"creation_form_instance_id": {
"type": "number"
},
"profile_form_instance_id": {
"type": "number"
}
},
"required": [
"id",
"name",
"alias",
"description",
"is_active",
"system_required",
"creation_form_instance_id",
"profile_form_instance_id"
],
"additionalProperties": false
}
},
"required": [
"id",
"alias",
"position",
"system_required",
"name",
"description",
"is_active"
],
"additionalProperties": false
},
"domains": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"alias": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"is_editable": {
"type": "boolean"
},
"is_removable": {
"type": "boolean"
},
"is_active": {
"type": "boolean"
},
"pso_type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"system_required": {
"type": "boolean"
},
"creation_form_instance_id": {
"type": "number"
},
"profile_form_instance_id": {
"type": "number"
}
},
"required": [
"id",
"name",
"alias",
"description",
"is_active",
"system_required",
"creation_form_instance_id",
"profile_form_instance_id"
],
"additionalProperties": false
}
},
"required": [
"id",
"alias",
"name",
"description",
"is_editable",
"is_removable",
"is_active"
]
}
},
"privacy_level": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"alias": {
"type": "string"
},
"name": {
"type": "string"
},
"level": {
"type": "number"
}
},
"required": [
"id",
"alias",
"name",
"level"
],
"additionalProperties": false
},
"pso_type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"system_required": {
"type": "boolean"
},
"creation_form_instance_id": {
"type": "number"
},
"profile_form_instance_id": {
"type": "number"
}
},
"required": [
"id",
"name",
"alias",
"description",
"is_active",
"system_required",
"creation_form_instance_id",
"profile_form_instance_id"
],
"additionalProperties": false
},
"items": {
"type": [
"array",
"null"
],
"items": {
"type": "object",
"properties": {}
}
},
"options": {
"type": [
"array",
"null"
],
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"position": {
"type": "number"
},
"value": {
"type": "string"
},
"is_active": {
"type": "boolean"
}
},
"required": [
"id",
"name",
"position",
"value",
"is_active"
]
},
"description": "List of options with possible (allowed) values."
},
"settings": {
"type": "array",
"items": {
"type": "string"
},
"description": "Common field settings"
}
},
"required": [
"id",
"name",
"position",
"alias",
"has_unique_data",
"has_value",
"removable",
"is_active",
"list",
"read_only",
"required"
]
},
"assignment_rules": {
"type": "array"
},
"field_access_rules": {
"type": "object",
"properties": {
"domains": {
"type": "object",
"properties": {
"includes": {
"type": "array"
},
"excludes": {
"type": "array"
}
},
"required": [
"includes",
"excludes"
]
},
"privacy_level": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"alias": {
"type": "string"
},
"name": {
"type": "string"
},
"level": {
"type": "number"
}
},
"required": [
"id",
"alias",
"name",
"level"
]
}
},
"required": [
"domains",
"privacy_level"
]
},
"features": {
"type": "array"
},
"modules": {
"type": "array"
},
"pso_type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"system_required": {
"type": "boolean"
},
"creation_form_instance_id": {
"type": "number"
},
"profile_form_instance_id": {
"type": "number"
}
},
"required": [
"id",
"name",
"alias",
"description",
"is_active",
"system_required",
"creation_form_instance_id",
"profile_form_instance_id"
]
}
},
"required": [
"id",
"alias",
"name",
"description",
"is_active",
"status",
"assignment_mode",
"permissions",
"relation_type"
]
}
}
}401Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 401
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}403Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 403
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}404Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 404
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}406Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 406
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}422Headers
Content-Type: application/jsonBody
{
"message": "Descriptive error message",
"status_code": 422,
"errors": [
"Error message"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
},
"errors": {
"type": "array"
}
}
}500Headers
Content-Type: application/jsonBody
{
"message": "Internal Error",
"status_code": 500
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}CreatePOST/roles
Create new role
Example URI
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>Body
{
"name": {
"en": "Some text",
"fr": "Du texte",
"de": "Setwas Text",
"es": "Algún texto"
},
"description": {
"en": "Some text",
"fr": "Du texte",
"de": "Setwas Text",
"es": "Algún texto"
},
"relation_field": "hr",
"relation_type": "relation_type",
"pso_type": "usr",
"assignment_rules": [
{
"assignee": {
"type": "all",
"details": {}
},
"population": {
"type": "all",
"details": {}
}
}
],
"field_access_rules": {
"domains": {
"includes": [
"domain_alias"
],
"excludes": [
"domain_alias"
]
},
"privacy_level": "public"
},
"modules": [
{
"id": 1,
"permissions": {
"access": true,
"synchronisation": false
}
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"name": {
"type": "object",
"properties": {
"en": {
"type": "string"
},
"fr": {
"type": "string"
},
"de": {
"type": "string"
},
"es": {
"type": "string"
}
},
"required": [
"en",
"fr",
"de",
"es"
]
},
"description": {
"type": "object",
"properties": {
"en": {
"type": "string"
},
"fr": {
"type": "string"
},
"de": {
"type": "string"
},
"es": {
"type": "string"
}
},
"required": [
"en",
"fr",
"de",
"es"
]
},
"relation_field": {
"type": "string"
},
"relation_type": {
"type": "string"
},
"pso_type": {
"type": "string"
},
"assignment_rules": {
"type": "array"
},
"field_access_rules": {
"type": "object",
"properties": {
"domains": {
"type": "object",
"properties": {
"includes": {
"type": "array"
},
"excludes": {
"type": "array"
}
},
"required": [
"includes",
"excludes"
]
},
"privacy_level": {
"type": "string"
}
},
"required": [
"domains",
"privacy_level"
]
},
"modules": {
"type": "array"
}
},
"required": [
"name",
"pso_type",
"assignment_rules",
"field_access_rules",
"modules"
]
}201Headers
Content-Type: application/jsonBody
{
"data": {
"id": 1,
"alias": "role_alias",
"name": "Role Name",
"description": "Role Description",
"is_active": true,
"status": "ok",
"assignment_mode": "role_driven",
"permissions": {
"can_edit": true,
"can_delete": true
},
"relation_type": {
"alias": "relation_alias",
"name": "Relation Name"
},
"relation_field": {
"id": 1,
"name": "Field Name",
"position": 5,
"alias": "usr_first_name",
"has_unique_data": false,
"has_value": true,
"removable": false,
"is_active": true,
"list": false,
"read_only": false,
"required": true,
"type": {
"id": 1,
"name": "Data Type Name",
"alias": "data_type_alias",
"settings": [
{
"id": 1,
"name": "Data Type Setting Name",
"alias": "data_type_setting_alias",
"is_required": true
}
],
"supports_collection": false,
"supports_read_only": false,
"supports_unique": false
},
"category": {
"id": 32,
"alias": "usr_identity",
"position": 5,
"system_required": true,
"name": "Identity",
"description": "...",
"is_active": true,
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
}
},
"domains": [
{
"id": 46,
"alias": "usr_global",
"name": "User Global",
"description": "...",
"is_editable": false,
"is_removable": false,
"is_active": true,
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
}
}
],
"privacy_level": {
"id": 123,
"alias": "public",
"name": "Not Sensitive",
"level": 100
},
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
},
"items": [
{}
],
"options": [
{
"id": 198,
"name": "Chose me!",
"position": 9,
"value": "198",
"is_active": true
}
],
"settings": []
},
"assignment_rules": [
{
"assignee": {
"type": "all",
"details": {}
},
"population": {
"type": "all",
"details": {}
}
}
],
"field_access_rules": {
"domains": {
"includes": [
{
"id": 46,
"alias": "usr_global",
"name": "User Global",
"description": "...",
"is_editable": false,
"is_removable": false,
"is_active": true,
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
}
}
],
"excludes": [
{
"id": 46,
"alias": "usr_global",
"name": "User Global",
"description": "...",
"is_editable": false,
"is_removable": false,
"is_active": true,
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
}
}
]
},
"privacy_level": {
"id": 1,
"alias": "privacy_level_alias",
"name": "Privacy Level Name",
"level": 500
}
},
"features": [
{
"id": 1,
"alias": "feature_alias",
"name": "Feature Name"
}
],
"modules": [
{
"id": 1,
"name": "Module name",
"alias": "mdl",
"app_url": {
"android": "http://android/app/url",
"ios": "http://ios/app/url"
},
"store_url": {
"android": "http://android/store/url",
"ios": "http://ios/store/url"
},
"web_url": "http://web/url",
"icon": "http://image.png",
"permissions": [
{
"access": true,
"synchronisation": true
}
]
}
],
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"alias": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"status": {
"type": "string",
"enum": [
"ok",
"pending",
"processing",
"conflict",
"failed"
]
},
"assignment_mode": {
"type": "string",
"enum": [
"user_driven",
"role_driven",
"system_driven"
]
},
"permissions": {
"type": "object",
"properties": {
"can_edit": {
"type": "boolean"
},
"can_delete": {
"type": "boolean"
}
},
"required": [
"can_edit",
"can_delete"
]
},
"relation_type": {
"type": "object",
"properties": {
"alias": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"alias",
"name"
]
},
"relation_field": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"position": {
"type": "number"
},
"alias": {
"type": "string"
},
"has_unique_data": {
"type": "boolean",
"description": "whether field requires values to be unique across system"
},
"has_value": {
"type": "boolean",
"description": "whether field has at least one value submitted"
},
"removable": {
"type": "boolean",
"description": "whether field can be removed from system"
},
"is_active": {
"type": "boolean"
},
"list": {
"type": "boolean",
"description": "whether field can handle collection of values"
},
"read_only": {
"type": "boolean",
"description": "whether field value can be changed"
},
"required": {
"type": "boolean",
"description": "whether field value required by system"
},
"type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"settings": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"is_required": {
"type": "boolean"
}
},
"required": [
"id",
"name",
"alias",
"is_required"
]
}
},
"supports_collection": {
"type": "boolean"
},
"supports_read_only": {
"type": "boolean"
},
"supports_unique": {
"type": "boolean"
}
},
"required": [
"id",
"name",
"alias",
"settings",
"supports_collection",
"supports_read_only",
"supports_unique"
],
"additionalProperties": false
},
"category": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"alias": {
"type": "string"
},
"position": {
"type": "number"
},
"system_required": {
"type": "boolean"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"pso_type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"system_required": {
"type": "boolean"
},
"creation_form_instance_id": {
"type": "number"
},
"profile_form_instance_id": {
"type": "number"
}
},
"required": [
"id",
"name",
"alias",
"description",
"is_active",
"system_required",
"creation_form_instance_id",
"profile_form_instance_id"
],
"additionalProperties": false
}
},
"required": [
"id",
"alias",
"position",
"system_required",
"name",
"description",
"is_active"
],
"additionalProperties": false
},
"domains": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"alias": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"is_editable": {
"type": "boolean"
},
"is_removable": {
"type": "boolean"
},
"is_active": {
"type": "boolean"
},
"pso_type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"system_required": {
"type": "boolean"
},
"creation_form_instance_id": {
"type": "number"
},
"profile_form_instance_id": {
"type": "number"
}
},
"required": [
"id",
"name",
"alias",
"description",
"is_active",
"system_required",
"creation_form_instance_id",
"profile_form_instance_id"
],
"additionalProperties": false
}
},
"required": [
"id",
"alias",
"name",
"description",
"is_editable",
"is_removable",
"is_active"
]
}
},
"privacy_level": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"alias": {
"type": "string"
},
"name": {
"type": "string"
},
"level": {
"type": "number"
}
},
"required": [
"id",
"alias",
"name",
"level"
],
"additionalProperties": false
},
"pso_type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"system_required": {
"type": "boolean"
},
"creation_form_instance_id": {
"type": "number"
},
"profile_form_instance_id": {
"type": "number"
}
},
"required": [
"id",
"name",
"alias",
"description",
"is_active",
"system_required",
"creation_form_instance_id",
"profile_form_instance_id"
],
"additionalProperties": false
},
"items": {
"type": [
"array",
"null"
],
"items": {
"type": "object",
"properties": {}
}
},
"options": {
"type": [
"array",
"null"
],
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"position": {
"type": "number"
},
"value": {
"type": "string"
},
"is_active": {
"type": "boolean"
}
},
"required": [
"id",
"name",
"position",
"value",
"is_active"
]
},
"description": "List of options with possible (allowed) values."
},
"settings": {
"type": "array",
"items": {
"type": "string"
},
"description": "Common field settings"
}
},
"required": [
"id",
"name",
"position",
"alias",
"has_unique_data",
"has_value",
"removable",
"is_active",
"list",
"read_only",
"required"
]
},
"assignment_rules": {
"type": "array"
},
"field_access_rules": {
"type": "object",
"properties": {
"domains": {
"type": "object",
"properties": {
"includes": {
"type": "array"
},
"excludes": {
"type": "array"
}
},
"required": [
"includes",
"excludes"
]
},
"privacy_level": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"alias": {
"type": "string"
},
"name": {
"type": "string"
},
"level": {
"type": "number"
}
},
"required": [
"id",
"alias",
"name",
"level"
]
}
},
"required": [
"domains",
"privacy_level"
]
},
"features": {
"type": "array"
},
"modules": {
"type": "array"
},
"pso_type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"system_required": {
"type": "boolean"
},
"creation_form_instance_id": {
"type": "number"
},
"profile_form_instance_id": {
"type": "number"
}
},
"required": [
"id",
"name",
"alias",
"description",
"is_active",
"system_required",
"creation_form_instance_id",
"profile_form_instance_id"
]
}
},
"required": [
"id",
"alias",
"name",
"description",
"is_active",
"status",
"assignment_mode",
"permissions",
"relation_type"
],
"additionalProperties": false
}
}
}400Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 400
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}401Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 401
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}403Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 403
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}404Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 404
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}406Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 406
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}422Headers
Content-Type: application/jsonBody
{
"message": "Descriptive error message",
"status_code": 422,
"errors": [
"Error message"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
},
"errors": {
"type": "array"
}
}
}500Headers
Content-Type: application/jsonBody
{
"message": "Internal Error",
"status_code": 500
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}UpdatePATCH/roles/{alias}
Update role
Example URI
- alias
string(required) Example: role_aliasalias of the rolex
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>Body
{
"name": {
"en": "Some text",
"fr": "Du texte",
"de": "Setwas Text",
"es": "Algún texto"
},
"description": {
"en": "Some text",
"fr": "Du texte",
"de": "Setwas Text",
"es": "Algún texto"
},
"pso_type": "usr",
"assignment_rules": [
{
"assignee": {
"type": "all",
"details": {}
},
"population": {
"type": "all",
"details": {}
}
}
],
"field_access_rules": {
"domains": {
"includes": [
"domain_alias"
],
"excludes": [
"domain_alias"
]
},
"privacy_level": "public"
},
"modules": [
{
"id": 1,
"permissions": {
"access": true,
"synchronisation": false
}
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"name": {
"type": "object",
"properties": {
"en": {
"type": "string"
},
"fr": {
"type": "string"
},
"de": {
"type": "string"
},
"es": {
"type": "string"
}
},
"required": [
"en",
"fr",
"de",
"es"
]
},
"description": {
"type": "object",
"properties": {
"en": {
"type": "string"
},
"fr": {
"type": "string"
},
"de": {
"type": "string"
},
"es": {
"type": "string"
}
},
"required": [
"en",
"fr",
"de",
"es"
]
},
"pso_type": {
"type": "string"
},
"assignment_rules": {
"type": "array"
},
"field_access_rules": {
"type": "object",
"properties": {
"domains": {
"type": "object",
"properties": {
"includes": {
"type": "array"
},
"excludes": {
"type": "array"
}
},
"required": [
"includes",
"excludes"
]
},
"privacy_level": {
"type": "string"
}
},
"required": [
"domains",
"privacy_level"
]
},
"modules": {
"type": "array"
}
},
"required": [
"pso_type",
"assignment_rules",
"field_access_rules"
]
}202Headers
Content-Type: application/json400Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 400
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}401Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 401
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}403Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 403
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}404Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 404
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}406Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 406
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}422Headers
Content-Type: application/jsonBody
{
"message": "Descriptive error message",
"status_code": 422,
"errors": [
"Error message"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
},
"errors": {
"type": "array"
}
}
}500Headers
Content-Type: application/jsonBody
{
"message": "Internal Error",
"status_code": 500
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}DeleteDELETE/roles/{alias}
Remove specified role
Example URI
- alias
string(required) Example: role_aliasalias of the role
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>204Headers
Content-Type: application/json400Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 400
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}401Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 401
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}403Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 403
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}404Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 404
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}406Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 406
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}422Headers
Content-Type: application/jsonBody
{
"message": "Descriptive error message",
"status_code": 422,
"errors": [
"Error message"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
},
"errors": {
"type": "array"
}
}
}500Headers
Content-Type: application/jsonBody
{
"message": "Internal Error",
"status_code": 500
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}Global Search ¶
Global search for search PSO’s by params.
Global Search ¶
Global SearchGET/search
Search PSO with filters.
If you have any search preferences response will handle it.
But anyway following fields data will always presented in response:
-
first name
-
last name
-
image
-
active
-
professional mobile phone
-
professional phone
-
professional email
Example URI
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>Body
{
"name": "John Doe",
"pso-type": "usr",
"active": true,
"formula": "{usr_first_name} not_empty"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "filter PSOs by full name."
},
"pso-type": {
"type": "string",
"description": "if you need to get only single PSO type fata."
},
"active": {
"type": "boolean",
"description": "if need to get only active PSOs."
},
"formula": {
"type": "string",
"description": "search formula to filter PSOs by fields."
}
},
"required": [
"pso-type",
"active"
]
}200Headers
Content-Type: application/jsonBody
{
"data": [
{
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
},
"data": [
{
"id": 1,
"status": "default",
"profile_form": {
"id": 1,
"name": "User Profile",
"description": "...",
"is_active": true,
"active_field": {
"id": 1,
"alias": "usr_field_alias",
"name": "Field Name",
"value": "value",
"raw_value": [
"value"
]
}
},
"fields": [
{
"id": 1,
"alias": "usr_field_alias",
"name": "Field Name",
"value": "value",
"raw_value": [
"value"
]
}
]
}
],
"meta": {
"pagination": {
"total": 238,
"count": 25,
"per_page": 25,
"current_page": 2,
"total_pages": 10,
"links": {
"previous": "http://example.com/api/<endpoint>?page=1",
"next": "http://example.com/api/<endpoint>?page=3"
}
}
}
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"pso_type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"system_required": {
"type": "boolean"
},
"creation_form_instance_id": {
"type": "number"
},
"profile_form_instance_id": {
"type": "number"
}
},
"required": [
"id",
"name",
"alias",
"description",
"is_active",
"system_required",
"creation_form_instance_id",
"profile_form_instance_id"
],
"additionalProperties": false
},
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"status": {
"type": "string"
},
"profile_form": {
"type": "object",
"properties": {
"id": {
"type": "number",
"description": "PSO Type Profile Form ID"
},
"name": {
"type": "string",
"description": "PSO Type Profile Form name"
},
"description": {
"type": "string",
"description": "PSO Type Profile Form description"
},
"is_active": {
"type": "boolean",
"description": "if need to get only active PSOs."
},
"active_field": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"alias": {
"type": "string"
},
"name": {
"type": "string"
},
"value": {
"type": "string"
},
"raw_value": {
"type": "array"
}
},
"required": [
"id",
"alias",
"name",
"value",
"raw_value"
],
"additionalProperties": false
}
},
"required": [
"id",
"name",
"description",
"is_active",
"active_field"
],
"additionalProperties": false
},
"fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"alias": {
"type": "string"
},
"name": {
"type": "string"
},
"value": {
"type": "string"
},
"raw_value": {
"type": "array"
}
},
"required": [
"id",
"alias",
"name",
"value",
"raw_value"
]
}
}
},
"required": [
"id",
"status"
]
}
},
"meta": {
"type": "object",
"properties": {
"pagination": {
"type": "object",
"properties": {
"total": {
"type": "number"
},
"count": {
"type": "number"
},
"per_page": {
"type": "number"
},
"current_page": {
"type": "number"
},
"total_pages": {
"type": "number"
},
"links": {
"type": "object",
"properties": {
"previous": {
"type": "string"
},
"next": {
"type": "string"
}
},
"required": [
"previous",
"next"
]
}
},
"required": [
"total",
"count",
"per_page",
"current_page",
"total_pages",
"links"
],
"additionalProperties": false
}
},
"required": [
"pagination"
],
"additionalProperties": false
}
}
}
}
}
}401Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 401
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}403Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 403
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}404Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 404
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}406Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 406
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}422Headers
Content-Type: application/jsonBody
{
"message": "Descriptive error message",
"status_code": 422,
"errors": [
"Error message"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
},
"errors": {
"type": "array"
}
}
}500Headers
Content-Type: application/jsonBody
{
"message": "Internal Error",
"status_code": 500
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}Sensitivities ¶
Triggers ¶
Triggers items.
Triggers ¶
ListGET/triggers{?include,name,type,active,sort-by,sort-direction,page,per-page}
Fetch list of triggers
Example URI
- name
string(optional) Example: Triggers to searchSearch by triggers title. Non strict, case-insensitive.
- type
plain, pso(optional) Example: plainFilter by triggers type.
- active
bool(optional) Example: Triggers statusFilter by triggers active status.
- sort-by
publish-date, title(optional) Default: publish-date Example: titleField to sort triggers by.
- sort-direction
asc, desc(optional) Default: desc Example: ascDirection to order triggers by.
- page
integer(optional) Example: 1- Page of results
- per-page
integer(optional) Example: 25- Triggers per page
- include
string(optional) Example: conditions,handlersComma separated list of related resources that will be included into response.
Possible values:
-
conditions
-
handlers
-
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>200Headers
Content-Type: application/jsonBody
{
"data": [
{
"id": 1,
"name Trigger title": "",
"description Some text": "",
"pso_type": 1,
"start_at": "2019-04-24 11:47:47",
"till_at": "2019-04-24 11:47:47",
"executed_at": "2019-04-24 11:47:47",
"frequency": "daily",
"is_active": true,
"created_at": "2019-04-24 11:47:47",
"updated_at": "2019-04-24 11:47:47",
"conditions": [
{
"type": "group",
"combine_with": "and",
"conditions": [
{
"type": "condition",
"field": "usr_email",
"raw_value": "john.doe@example.com",
"operator": "=="
}
]
}
],
"handlers": [
{
"id": 1,
"type": "notification",
"population": [
{
"type": "group",
"details": {
"dynamic": false,
"includes": [
"group_a"
],
"excludes": [
"group_b",
"group_c"
]
}
}
],
"payload": {}
}
]
}
],
"meta": {
"pagination": {
"total": 238,
"count": 25,
"per_page": 25,
"current_page": 2,
"total_pages": 10,
"links": {
"previous": "http://example.com/api/<endpoint>?page=1",
"next": "http://example.com/api/<endpoint>?page=3"
}
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name Trigger title": {
"type": "string"
},
"description Some text": {
"type": "string"
},
"pso_type": {
"type": "number"
},
"start_at": {
"type": "string"
},
"till_at": {
"type": "string"
},
"executed_at": {
"type": "string"
},
"frequency": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"created_at": {
"type": "string"
},
"updated_at": {
"type": "string"
},
"conditions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"group"
]
},
"combine_with": {
"type": "string",
"enum": [
"and",
"or"
]
},
"conditions": {
"type": "array"
}
},
"required": [
"type",
"combine_with",
"conditions"
]
}
},
"handlers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"type": {
"type": "string",
"enum": [
"notification",
"action_todo",
"action_schedule",
"field_modification",
"form_assignment"
]
},
"population": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"all",
"group",
"pso",
"relation"
]
},
"details": {
"anyOf": [
{
"type": "object",
"properties": {
"dynamic": {
"type": "boolean"
},
"includes": {
"type": "array"
},
"excludes": {
"type": "array"
}
},
"required": [
"dynamic",
"includes",
"excludes"
]
},
{
"type": "array",
"enum": [
[],
[]
]
}
],
"type": "null"
}
},
"required": [
"type",
"details"
]
}
},
"payload": {
"type": "object",
"properties": {},
"additionalProperties": false
}
},
"required": [
"id",
"type"
]
}
}
},
"required": [
"id",
"name Trigger title",
"description Some text",
"pso_type",
"start_at",
"till_at",
"executed_at",
"frequency",
"is_active",
"created_at",
"updated_at"
]
}
},
"meta": {
"type": "object",
"properties": {
"pagination": {
"type": "object",
"properties": {
"total": {
"type": "number"
},
"count": {
"type": "number"
},
"per_page": {
"type": "number"
},
"current_page": {
"type": "number"
},
"total_pages": {
"type": "number"
},
"links": {
"type": "object",
"properties": {
"previous": {
"type": "string"
},
"next": {
"type": "string"
}
},
"required": [
"previous",
"next"
]
}
},
"required": [
"total",
"count",
"per_page",
"current_page",
"total_pages",
"links"
],
"additionalProperties": false
}
},
"required": [
"pagination"
]
}
}
}401Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 401
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}403Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 403
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}404Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 404
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}406Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 406
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}422Headers
Content-Type: application/jsonBody
{
"message": "Descriptive error message",
"status_code": 422,
"errors": [
"Error message"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
},
"errors": {
"type": "array"
}
}
}500Headers
Content-Type: application/jsonBody
{
"message": "Internal Error",
"status_code": 500
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}CreatePOST/triggers
Create new trigger entry
Most part of properties are simple and described in JSON schema. But there are 2 properties (conditions and handlers) that need to be explained.
Conditions
Condition uses to describe rules that will be applied as filers on trigger execution.
Condition can be of 2 types - group and condition itself
Group
It should be used to combine set of conditions with logical operator (or, and)
Example
{
"type": "group",
"combine_with": "and",
"conditions": []
}
Condition
It should be used to describe the field based rule (filter)
Compare field value with raw value example
{
"type": "condition",
"field": "usr_email",
"operator": "==",
"raw_value": "john.doe@example.com"
}
Compare two field values example
{
"type": "condition",
"field": "usr_first_name",
"operator": "==",
"field_value": "usr_last_name"
}
Nesting conditions
Conditions and groups can be nested into each other to represent complex expressions
Example (usr_name == Foo or usr_email != xxx@example.com)
{
"type": "group",
"combine_with": "or",
"conditions": [
{
"type": "condition",
"field": "usr_name",
"operator": "==",
"raw_value": "Foo"
},
{
"type": "condition",
"field": "usr_email",
"operator": "!=",
"raw_value": "xxx@example.com"
}
]
}
Example ((usr_name == Foo and usr_email != xxx@example.com) or usr_hired_at > 2010-01-12)
{
"type": "group",
"combine_with": "or",
"conditions": [
{
"type": "group",
"combine_with": "and",
"conditions": [
{
"type": "condition",
"field": "usr_name",
"operator": "==",
"raw_value": "Foo"
},
{
"type": "condition",
"field": "usr_email",
"operator": "!=",
"raw_value": "xxx@example.com"
}
]
},
{
"type": "condition",
"field": "usr_hired_at",
"operator": ">",
"raw_value": "2010-01-12"
}
]
}
Handlers
Each handler entry has:
-
type (determine payload structure and handling on server side). Allowed options:
- notification
- action_todo
- action_schedule
- field_modification
- form_assignment
- pso_deletion
- data_deletion
-
population (describes PSO that will be used as population\recipient once trigger executed)
-
payload (additional info that depends on type)
Handler population
Population is array of different populations. Each kind of population item defined by type property. Available types:
-
all (all active PSOs of given type - see pso_type in main section)
-
group (specified groups)
-
pso (specific PSOs)
-
relation (self or alias of field with relation type)
Population items can be combined. So in population array we may have few entries with different types
Examples: For all type:
[
{
"type": "all",
"details": null
}
]
For self type:
[
{
"type": "self",
"details": null
}
]
For group type:
[
{
"type": "group",
"details": {
"dynamic": true,
"includes": ["group_a", "group_b"],
"excludes": ["group_c", "group_d"]
}
}
]
For pso type:
[
{
"type": "pso",
"details": [123, 456]
}
]
For relation type:
[
{
"type": "relation",
"details": [
"user",
"manager",
"..."
]
}
]
Mixed types:
[
{
"type": "group",
"details": {
"dynamic": true,
"includes": ["group_a", "group_b"],
"excludes": ["group_c", "group_d"]
}
},
{
"type": "pso",
"details": [123, 456]
},
{
"type": "relation",
"details": [
"self",
"manager",
"..."
]
}
]
Handler substitutions
Supports only for notification, action_todo, action_schedule handler types.
Substitutions is an array of variables that presented in title and message fields. And used to replace these variables in the text to data from trigger recipients (they described at Population section) or from psos found through conditions.
Variables from recipients:
syntax: {$<field_alias>}.
Variables from psos found through conditions:
syntax: {@usr_first_name}.
Example:
[
"{$usr_first_name}",
"{$usr_last_name}"
]
Handler payload examples
For notification type
If the trigger has conditions and {@} variables in substitutions array.
All recipients are getting as many notifications as psos had found through conditions.
If no {@} variable in substitutions array, recipients are getting only one notification.
{
"title": {
"en": "...",
"es": "...",
"de": "...",
"fr": "..."
},
"message": {
"en": "...",
"es": "...",
"de": "...",
"fr": "..."
},
"channels": [
"web",
"email"
],
"raw_recipients": [
"aaa@email.com",
"bbb@email.com"
],
"substitutions": [
"{$usr_first_name}",
"{$usr_last_name}",
"{@usr_first_name}",
]
}
For action_todo type
If the trigger has conditions and {@} variables in substitutions array.
For each recipient will be created as many actions as psos had found through conditions.
If no {@} variable in substitutions array, only one action will be created for each recipient
{
"title": {
"en": "...",
"es": "...",
"de": "...",
"fr": "..."
},
"message": {
"en": "...",
"es": "...",
"de": "...",
"fr": "..."
},
"due_date": "2019-02-34 12:34:56",
"substitutions": [
"{$usr_first_name}",
"{$usr_last_name}",
"{@usr_first_name}",
]
}
For action_schedule type
If the trigger has conditions and {@} variables in substitutions array.
For each recipient will be created as many actions as psos had found through conditions.
If no {@} variable in substitutions array, only one action will be created for each recipient
{
"title": {
"en": "...",
"es": "...",
"de": "...",
"fr": "..."
},
"message": {
"en": "...",
"es": "...",
"de": "...",
"fr": "..."
},
"due_date": "2019-02-34 12:34:56",
"substitutions": [
"{$usr_first_name}",
"{$usr_last_name}",
"{@usr_first_name}",
]
}
For field_modification type
{
"field": "xxx_field_alias",
"expression": "new value"
}
For form_assignment type
{
"title": {
"en": "...",
"es": "...",
"de": "...",
"fr": "..."
},
"description": {
"en": "...",
"es": "...",
"de": "...",
"fr": "..."
},
"form": 12345,
"assignment_rules": {
"type": "permanent|unique|periodic",
"settings": [
{
"alias": "start_date",
"value": "Y-m-d H:i:s"
}
]
}
}
For pso_deletion type
Should be "null" or even omitted
For data_deletion type
{
"clear_history": clear_historyfalse,
"fields": [
'usr_field_a',
'usr_field_b'
]
}
Example URI
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: '*'Body
{
"name": {
"en": "Some text",
"fr": "Du texte",
"de": "Setwas Text",
"es": "Algún texto"
},
"description": {
"en": "Some text",
"fr": "Du texte",
"de": "Setwas Text",
"es": "Algún texto"
},
"pso_type": "usr",
"start_at": "2019-04-24 11:47:47",
"till_at": "2019-04-24 11:47:47",
"frequency": "daily",
"is_active": true,
"conditions": [
{
"type": "group",
"combine_with": "and",
"conditions": [
{
"type": "condition",
"field": "usr_email",
"raw_value": "john.doe@example.com",
"operator": "=="
}
]
}
],
"handlers": [
{
"id": 1,
"type": "notification",
"population": [
{
"type": "group",
"details": {
"dynamic": false,
"includes": [
"group_a"
],
"excludes": [
"group_b",
"group_c"
]
}
}
],
"payload": {}
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"name": {
"type": "object",
"properties": {
"en": {
"type": "string"
},
"fr": {
"type": "string"
},
"de": {
"type": "string"
},
"es": {
"type": "string"
}
},
"required": [
"en",
"fr",
"de",
"es"
],
"additionalProperties": false
},
"description": {
"type": "object",
"properties": {
"en": {
"type": "string"
},
"fr": {
"type": "string"
},
"de": {
"type": "string"
},
"es": {
"type": "string"
}
},
"required": [
"en",
"fr",
"de",
"es"
],
"additionalProperties": false
},
"pso_type": {
"type": "string"
},
"start_at": {
"type": "string"
},
"till_at": {
"type": "string"
},
"frequency": {
"type": "string",
"description": "can be one of: daily,weekly,monthly,yearly"
},
"is_active": {
"type": "boolean"
},
"conditions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"group"
]
},
"combine_with": {
"type": "string",
"enum": [
"and",
"or"
]
},
"conditions": {
"type": "array"
}
},
"required": [
"type",
"combine_with",
"conditions"
]
}
},
"handlers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"type": {
"type": "string",
"enum": [
"notification",
"action_todo",
"action_schedule",
"field_modification",
"form_assignment"
]
},
"population": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"all",
"group",
"pso",
"relation"
]
},
"details": {
"anyOf": [
{
"type": "object",
"properties": {
"dynamic": {
"type": "boolean"
},
"includes": {
"type": "array"
},
"excludes": {
"type": "array"
}
},
"required": [
"dynamic",
"includes",
"excludes"
]
},
{
"type": "array",
"enum": [
[],
[]
]
}
],
"type": "null"
}
},
"required": [
"type",
"details"
]
}
},
"payload": {
"type": "object",
"properties": {},
"additionalProperties": false
}
},
"required": [
"id",
"type"
]
}
}
},
"required": [
"pso_type",
"start_at",
"till_at",
"frequency",
"is_active"
]
}201Headers
Content-Type: application/jsonBody
{
"data": {
"id": 1,
"name Trigger title": "",
"description Some text": "",
"pso_type": 1,
"start_at": "2019-04-24 11:47:47",
"till_at": "2019-04-24 11:47:47",
"executed_at": "2019-04-24 11:47:47",
"frequency": "daily",
"is_active": true,
"created_at": "2019-04-24 11:47:47",
"updated_at": "2019-04-24 11:47:47",
"conditions": [
{
"type": "group",
"combine_with": "and",
"conditions": [
{
"type": "condition",
"field": "usr_email",
"raw_value": "john.doe@example.com",
"operator": "=="
}
]
}
],
"handlers": [
{
"id": 1,
"type": "notification",
"population": [
{
"type": "group",
"details": {
"dynamic": false,
"includes": [
"group_a"
],
"excludes": [
"group_b",
"group_c"
]
}
}
],
"payload": {}
}
]
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name Trigger title": {
"type": "string"
},
"description Some text": {
"type": "string"
},
"pso_type": {
"type": "number"
},
"start_at": {
"type": "string"
},
"till_at": {
"type": "string"
},
"executed_at": {
"type": "string"
},
"frequency": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"created_at": {
"type": "string"
},
"updated_at": {
"type": "string"
},
"conditions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"group"
]
},
"combine_with": {
"type": "string",
"enum": [
"and",
"or"
]
},
"conditions": {
"type": "array"
}
},
"required": [
"type",
"combine_with",
"conditions"
]
}
},
"handlers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"type": {
"type": "string",
"enum": [
"notification",
"action_todo",
"action_schedule",
"field_modification",
"form_assignment"
]
},
"population": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"all",
"group",
"pso",
"relation"
]
},
"details": {
"anyOf": [
{
"type": "object",
"properties": {
"dynamic": {
"type": "boolean"
},
"includes": {
"type": "array"
},
"excludes": {
"type": "array"
}
},
"required": [
"dynamic",
"includes",
"excludes"
]
},
{
"type": "array",
"enum": [
[],
[]
]
}
],
"type": "null"
}
},
"required": [
"type",
"details"
]
}
},
"payload": {
"type": "object",
"properties": {},
"additionalProperties": false
}
},
"required": [
"id",
"type"
]
}
}
},
"required": [
"id",
"name Trigger title",
"description Some text",
"pso_type",
"start_at",
"till_at",
"executed_at",
"frequency",
"is_active",
"created_at",
"updated_at",
"conditions",
"handlers"
],
"additionalProperties": false
}
}
}400Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 400
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}401Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 401
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}403Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 403
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}404Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 404
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}406Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 406
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}422Headers
Content-Type: application/jsonBody
{
"message": "Descriptive error message",
"status_code": 422,
"errors": [
"Error message"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
},
"errors": {
"type": "array"
}
}
}500Headers
Content-Type: application/jsonBody
{
"message": "Internal Error",
"status_code": 500
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}ShowGET/triggers/{id}
Fetch single trigger item
Example URI
- id
number(required) Example: queryId of the Trigger item.
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: '*'200Headers
Content-Type: application/jsonBody
{
"data": {
"id": 1,
"name Trigger title": "",
"description Some text": "",
"pso_type": 1,
"start_at": "2019-04-24 11:47:47",
"till_at": "2019-04-24 11:47:47",
"executed_at": "2019-04-24 11:47:47",
"frequency": "daily",
"is_active": true,
"created_at": "2019-04-24 11:47:47",
"updated_at": "2019-04-24 11:47:47",
"conditions": [
{
"type": "group",
"combine_with": "and",
"conditions": [
{
"type": "condition",
"field": "usr_email",
"raw_value": "john.doe@example.com",
"operator": "=="
}
]
}
],
"handlers": [
{
"id": 1,
"type": "notification",
"population": [
{
"type": "group",
"details": {
"dynamic": false,
"includes": [
"group_a"
],
"excludes": [
"group_b",
"group_c"
]
}
}
],
"payload": {}
}
]
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name Trigger title": {
"type": "string"
},
"description Some text": {
"type": "string"
},
"pso_type": {
"type": "number"
},
"start_at": {
"type": "string"
},
"till_at": {
"type": "string"
},
"executed_at": {
"type": "string"
},
"frequency": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"created_at": {
"type": "string"
},
"updated_at": {
"type": "string"
},
"conditions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"group"
]
},
"combine_with": {
"type": "string",
"enum": [
"and",
"or"
]
},
"conditions": {
"type": "array"
}
},
"required": [
"type",
"combine_with",
"conditions"
]
}
},
"handlers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"type": {
"type": "string",
"enum": [
"notification",
"action_todo",
"action_schedule",
"field_modification",
"form_assignment"
]
},
"population": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"all",
"group",
"pso",
"relation"
]
},
"details": {
"anyOf": [
{
"type": "object",
"properties": {
"dynamic": {
"type": "boolean"
},
"includes": {
"type": "array"
},
"excludes": {
"type": "array"
}
},
"required": [
"dynamic",
"includes",
"excludes"
]
},
{
"type": "array",
"enum": [
[],
[]
]
}
],
"type": "null"
}
},
"required": [
"type",
"details"
]
}
},
"payload": {
"type": "object",
"properties": {},
"additionalProperties": false
}
},
"required": [
"id",
"type"
]
}
}
},
"required": [
"id",
"name Trigger title",
"description Some text",
"pso_type",
"start_at",
"till_at",
"executed_at",
"frequency",
"is_active",
"created_at",
"updated_at",
"conditions",
"handlers"
],
"additionalProperties": false
}
}
}401Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 401
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}403Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 403
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}404Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 404
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}406Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 406
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}422Headers
Content-Type: application/jsonBody
{
"message": "Descriptive error message",
"status_code": 422,
"errors": [
"Error message"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
},
"errors": {
"type": "array"
}
}
}500Headers
Content-Type: application/jsonBody
{
"message": "Internal Error",
"status_code": 500
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}DeleteDELETE/triggers/{id}
Delete trigger item
Example URI
- id
number(required) Example: 123Id of the Trigger item.
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: '*'204Headers
Content-Type: application/json401Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 401
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}403Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 403
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}404Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 404
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}406Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 406
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}422Headers
Content-Type: application/jsonBody
{
"message": "Descriptive error message",
"status_code": 422,
"errors": [
"Error message"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
},
"errors": {
"type": "array"
}
}
}500Headers
Content-Type: application/jsonBody
{
"message": "Internal Error",
"status_code": 500
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}UpdatePATCH/triggers/{id}
Update trigger item
Example URI
- id
number(required) Example: 123Id of the trigger item.
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>Body
{
"name": {
"en": "Some text",
"fr": "Du texte",
"de": "Setwas Text",
"es": "Algún texto"
},
"description": {
"en": "Some text",
"fr": "Du texte",
"de": "Setwas Text",
"es": "Algún texto"
},
"pso_type": "usr",
"start_at": "2019-04-24 11:47:47",
"till_at": "2019-04-24 11:47:47",
"frequency": "daily",
"is_active": true,
"conditions": [
{
"type": "group",
"combine_with": "and",
"conditions": [
{
"type": "condition",
"field": "usr_email",
"raw_value": "john.doe@example.com",
"operator": "=="
}
]
}
],
"handlers": [
{
"id": 1,
"type": "notification",
"population": [
{
"type": "group",
"details": {
"dynamic": false,
"includes": [
"group_a"
],
"excludes": [
"group_b",
"group_c"
]
}
}
],
"payload": {}
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"name": {
"type": "object",
"properties": {
"en": {
"type": "string"
},
"fr": {
"type": "string"
},
"de": {
"type": "string"
},
"es": {
"type": "string"
}
},
"required": [
"en",
"fr",
"de",
"es"
],
"additionalProperties": false
},
"description": {
"type": "object",
"properties": {
"en": {
"type": "string"
},
"fr": {
"type": "string"
},
"de": {
"type": "string"
},
"es": {
"type": "string"
}
},
"required": [
"en",
"fr",
"de",
"es"
],
"additionalProperties": false
},
"pso_type": {
"type": "string"
},
"start_at": {
"type": "string"
},
"till_at": {
"type": "string"
},
"frequency": {
"type": "string",
"description": "can be one of: daily,weekly,monthly,yearly"
},
"is_active": {
"type": "boolean"
},
"conditions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"group"
]
},
"combine_with": {
"type": "string",
"enum": [
"and",
"or"
]
},
"conditions": {
"type": "array"
}
},
"required": [
"type",
"combine_with",
"conditions"
]
}
},
"handlers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"type": {
"type": "string",
"enum": [
"notification",
"action_todo",
"action_schedule",
"field_modification",
"form_assignment"
]
},
"population": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"all",
"group",
"pso",
"relation"
]
},
"details": {
"anyOf": [
{
"type": "object",
"properties": {
"dynamic": {
"type": "boolean"
},
"includes": {
"type": "array"
},
"excludes": {
"type": "array"
}
},
"required": [
"dynamic",
"includes",
"excludes"
]
},
{
"type": "array",
"enum": [
[],
[]
]
}
],
"type": "null"
}
},
"required": [
"type",
"details"
]
}
},
"payload": {
"type": "object",
"properties": {},
"additionalProperties": false
}
},
"required": [
"id",
"type"
]
}
}
}
}202Headers
Content-Type: application/jsonBody
{
"data": {
"id": 1,
"name Trigger title": "",
"description Some text": "",
"pso_type": 1,
"start_at": "2019-04-24 11:47:47",
"till_at": "2019-04-24 11:47:47",
"executed_at": "2019-04-24 11:47:47",
"frequency": "daily",
"is_active": true,
"created_at": "2019-04-24 11:47:47",
"updated_at": "2019-04-24 11:47:47",
"conditions": [
{
"type": "group",
"combine_with": "and",
"conditions": [
{
"type": "condition",
"field": "usr_email",
"raw_value": "john.doe@example.com",
"operator": "=="
}
]
}
],
"handlers": [
{
"id": 1,
"type": "notification",
"population": [
{
"type": "group",
"details": {
"dynamic": false,
"includes": [
"group_a"
],
"excludes": [
"group_b",
"group_c"
]
}
}
],
"payload": {}
}
]
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name Trigger title": {
"type": "string"
},
"description Some text": {
"type": "string"
},
"pso_type": {
"type": "number"
},
"start_at": {
"type": "string"
},
"till_at": {
"type": "string"
},
"executed_at": {
"type": "string"
},
"frequency": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"created_at": {
"type": "string"
},
"updated_at": {
"type": "string"
},
"conditions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"group"
]
},
"combine_with": {
"type": "string",
"enum": [
"and",
"or"
]
},
"conditions": {
"type": "array"
}
},
"required": [
"type",
"combine_with",
"conditions"
]
}
},
"handlers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"type": {
"type": "string",
"enum": [
"notification",
"action_todo",
"action_schedule",
"field_modification",
"form_assignment"
]
},
"population": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"all",
"group",
"pso",
"relation"
]
},
"details": {
"anyOf": [
{
"type": "object",
"properties": {
"dynamic": {
"type": "boolean"
},
"includes": {
"type": "array"
},
"excludes": {
"type": "array"
}
},
"required": [
"dynamic",
"includes",
"excludes"
]
},
{
"type": "array",
"enum": [
[],
[]
]
}
],
"type": "null"
}
},
"required": [
"type",
"details"
]
}
},
"payload": {
"type": "object",
"properties": {},
"additionalProperties": false
}
},
"required": [
"id",
"type"
]
}
}
},
"required": [
"id",
"name Trigger title",
"description Some text",
"pso_type",
"start_at",
"till_at",
"executed_at",
"frequency",
"is_active",
"created_at",
"updated_at",
"conditions",
"handlers"
],
"additionalProperties": false
}
}
}400Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 400
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}401Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 401
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}403Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 403
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}404Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 404
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}406Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 406
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}422Headers
Content-Type: application/jsonBody
{
"message": "Descriptive error message",
"status_code": 422,
"errors": [
"Error message"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
},
"errors": {
"type": "array"
}
}
}500Headers
Content-Type: application/jsonBody
{
"message": "Internal Error",
"status_code": 500
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}Scheduled Approvals ¶
Scheduled Approvals items.
Scheduled Approvals ¶
ListGET/scheduled-approvals{?expired,sort-by,sort-direction,include,page,per-page,no-pagination}
Fetch list of scheduled approvals
Example URI
- expired
boolean(optional) Default: false Example: trueInclude expired approvals.
- sort-by
form_instance, author, approval_scheduled_date, status(optional) Example: authorField to sort by. If not provided will be sorted by creation date.
- sort-direction
asc, desc(optional) Default: desc Example: ascDirection to order approvals by.
- include
string(optional) Example: authorComma separated list of related resources that will be included into response. Possible values:
-
author
-
form_instance
-
- page
number(required) Example: 1Page number.
1by default- per-page
number(required) Example: 10Number of items per page,
25by default- no-pagination
boolean(required) Example: falseif presented and positive pagination will not be applied. All available items will be returned.
Note: it may have significant impact on the performance
Note: once this option positive and presented -
metaattribute with pagination data will be omit in response
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: <target feature>200Headers
Content-Type: application/jsonBody
{
"data": [
{
"uuid": "34425f31-d9f3-37bd-b90d-e5a7f7f85fc1",
"status": "pending",
"is_mass_edit": true,
"approval_scheduled_date": "2019-04-24 11:47:47",
"author": {
"id": 1,
"external_id": 1,
"first_name": "John",
"last_name": "Snow",
"username": "john_snow",
"professional_email": "jsnow@example.com",
"professional_mobile_phone": "00 33 1 40 00 00 00",
"professional_phone": "00 33 1 40 00 00 00",
"role": [
"bastard",
"king"
],
"is_active": true,
"status": "remote",
"settings": [
"[]"
],
"user_photo": "http://example.com/images/1.jpg"
},
"form_instance": {
"id": 1,
"name": {
"en": "Some text",
"fr": "Du texte",
"de": "Setwas Text",
"es": "Algún texto"
},
"description": {
"en": "Some text",
"fr": "Du texte",
"de": "Setwas Text",
"es": "Algún texto"
},
"form_id": 123,
"is_active": true,
"removable": false,
"effective_date": "2019-04-24 11:47:47"
},
"scheduled_approvals": [
{
"id": 1,
"status": "pending",
"approval_scheduled_date": "2019-04-24 11:47:47",
"pso": {
"id": 1,
"external_id": 1,
"first_name": "John",
"last_name": "Snow",
"username": "john_snow",
"professional_email": "jsnow@example.com",
"professional_mobile_phone": "00 33 1 40 00 00 00",
"professional_phone": "00 33 1 40 00 00 00",
"role": [
"bastard",
"king"
],
"is_active": true,
"status": "remote",
"settings": [
"[]"
],
"user_photo": "http://example.com/images/1.jpg"
},
"fields": [
{
"id": 1,
"name": "Field Name",
"position": 5,
"alias": "usr_first_name",
"has_unique_data": false,
"has_value": true,
"removable": false,
"is_active": true,
"list": false,
"read_only": false,
"required": true,
"type": {
"id": 1,
"name": "Data Type Name",
"alias": "data_type_alias",
"settings": [
{
"id": 1,
"name": "Data Type Setting Name",
"alias": "data_type_setting_alias",
"is_required": true
}
],
"supports_collection": false,
"supports_read_only": false,
"supports_unique": false
},
"category": {
"id": 32,
"alias": "usr_identity",
"position": 5,
"system_required": true,
"name": "Identity",
"description": "...",
"is_active": true,
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
}
},
"domains": [
{
"id": 46,
"alias": "usr_global",
"name": "User Global",
"description": "...",
"is_editable": false,
"is_removable": false,
"is_active": true,
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
}
}
],
"privacy_level": {
"id": 123,
"alias": "public",
"name": "Not Sensitive",
"level": 100
},
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
},
"items": [
{
"id": 1,
"name": "Field Name",
"position": 5,
"alias": "usr_first_name",
"has_unique_data": false,
"has_value": true,
"removable": false,
"is_active": true,
"list": false,
"read_only": false,
"required": true,
"type": {
"id": 1,
"name": "Data Type Name",
"alias": "data_type_alias",
"settings": [
{
"id": 1,
"name": "Data Type Setting Name",
"alias": "data_type_setting_alias",
"is_required": true
}
],
"supports_collection": false,
"supports_read_only": false,
"supports_unique": false
},
"category": {
"id": 32,
"alias": "usr_identity",
"position": 5,
"system_required": true,
"name": "Identity",
"description": "...",
"is_active": true,
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
}
},
"domains": [
{
"id": 46,
"alias": "usr_global",
"name": "User Global",
"description": "...",
"is_editable": false,
"is_removable": false,
"is_active": true,
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
}
}
],
"privacy_level": {
"id": 123,
"alias": "public",
"name": "Not Sensitive",
"level": 100
},
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
},
"items": [
{}
],
"options": [
{
"id": 198,
"name": "Chose me!",
"position": 9,
"value": "198",
"is_active": true
}
],
"settings": []
}
],
"options": [
{
"id": 198,
"name": "Chose me!",
"position": 9,
"value": "198",
"is_active": true
}
],
"settings": [],
"is_locked": false,
"value_details": [
"value1",
"value2"
],
"values_count": 2,
"assignment_settings": [
{
"setting": "public",
"value": "1"
}
],
"access_permissions": {
"history": true,
"view": true,
"edit": true
},
"assignment_permissions": {
"permissions": {
"id": 1,
"name": "View",
"alias": "view"
},
"access_list": [
"0",
"1",
"1"
]
}
}
]
}
]
}
],
"meta": {
"pagination": {
"total": 238,
"count": 25,
"per_page": 25,
"current_page": 2,
"total_pages": 10,
"links": {
"previous": "http://example.com/api/<endpoint>?page=1",
"next": "http://example.com/api/<endpoint>?page=3"
}
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"uuid": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"pending",
"done",
"failed"
]
},
"is_mass_edit": {
"type": "boolean"
},
"approval_scheduled_date": {
"type": "string"
},
"author": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"external_id": {
"type": "number"
},
"first_name": {
"type": "string"
},
"last_name": {
"type": "string"
},
"username": {
"type": "string"
},
"professional_email": {
"type": "string"
},
"professional_mobile_phone": {
"type": "string"
},
"professional_phone": {
"type": "string"
},
"role": {
"type": "array"
},
"is_active": {
"type": "boolean"
},
"status": {
"type": "string"
},
"settings": {
"type": "array"
},
"user_photo": {
"type": "string"
}
},
"required": [
"id",
"external_id",
"first_name",
"last_name",
"username",
"professional_email",
"professional_mobile_phone",
"professional_phone",
"role",
"is_active",
"status",
"settings",
"user_photo"
],
"additionalProperties": false
},
"form_instance": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "object",
"properties": {
"en": {
"type": "string"
},
"fr": {
"type": "string"
},
"de": {
"type": "string"
},
"es": {
"type": "string"
}
},
"required": [
"en",
"fr",
"de",
"es"
]
},
"description": {
"type": "object",
"properties": {
"en": {
"type": "string"
},
"fr": {
"type": "string"
},
"de": {
"type": "string"
},
"es": {
"type": "string"
}
},
"required": [
"en",
"fr",
"de",
"es"
]
},
"form_id": {
"type": "number"
},
"is_active": {
"type": "boolean"
},
"removable": {
"type": "boolean"
},
"effective_date": {
"type": "string"
}
},
"required": [
"id",
"name",
"description",
"form_id",
"is_active",
"removable",
"effective_date"
],
"additionalProperties": false
},
"scheduled_approvals": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"status": {
"type": "string",
"enum": [
"pending",
"done",
"failed"
]
},
"approval_scheduled_date": {
"type": "string"
},
"pso": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"external_id": {
"type": "number"
},
"first_name": {
"type": "string"
},
"last_name": {
"type": "string"
},
"username": {
"type": "string"
},
"professional_email": {
"type": "string"
},
"professional_mobile_phone": {
"type": "string"
},
"professional_phone": {
"type": "string"
},
"role": {
"type": "array"
},
"is_active": {
"type": "boolean"
},
"status": {
"type": "string"
},
"settings": {
"type": "array"
},
"user_photo": {
"type": "string"
}
},
"required": [
"id",
"external_id",
"first_name",
"last_name",
"username",
"professional_email",
"professional_mobile_phone",
"professional_phone",
"role",
"is_active",
"status",
"settings",
"user_photo"
],
"additionalProperties": false
},
"fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"position": {
"type": "number"
},
"alias": {
"type": "string"
},
"has_unique_data": {
"type": "boolean",
"description": "whether field requires values to be unique across system"
},
"has_value": {
"type": "boolean",
"description": "whether field has at least one value submitted"
},
"removable": {
"type": "boolean",
"description": "whether field can be removed from system"
},
"is_active": {
"type": "boolean"
},
"list": {
"type": "boolean",
"description": "whether field can handle collection of values"
},
"read_only": {
"type": "boolean",
"description": "whether field value can be changed"
},
"required": {
"type": "boolean",
"description": "whether field value required by system"
},
"type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"settings": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"is_required": {
"type": "boolean"
}
},
"required": [
"id",
"name",
"alias",
"is_required"
]
}
},
"supports_collection": {
"type": "boolean"
},
"supports_read_only": {
"type": "boolean"
},
"supports_unique": {
"type": "boolean"
}
},
"required": [
"id",
"name",
"alias",
"settings",
"supports_collection",
"supports_read_only",
"supports_unique"
],
"additionalProperties": false
},
"category": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"alias": {
"type": "string"
},
"position": {
"type": "number"
},
"system_required": {
"type": "boolean"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"pso_type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"system_required": {
"type": "boolean"
},
"creation_form_instance_id": {
"type": "number"
},
"profile_form_instance_id": {
"type": "number"
}
},
"required": [
"id",
"name",
"alias",
"description",
"is_active",
"system_required",
"creation_form_instance_id",
"profile_form_instance_id"
],
"additionalProperties": false
}
},
"required": [
"id",
"alias",
"position",
"system_required",
"name",
"description",
"is_active"
],
"additionalProperties": false
},
"domains": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"alias": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"is_editable": {
"type": "boolean"
},
"is_removable": {
"type": "boolean"
},
"is_active": {
"type": "boolean"
},
"pso_type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"system_required": {
"type": "boolean"
},
"creation_form_instance_id": {
"type": "number"
},
"profile_form_instance_id": {
"type": "number"
}
},
"required": [
"id",
"name",
"alias",
"description",
"is_active",
"system_required",
"creation_form_instance_id",
"profile_form_instance_id"
],
"additionalProperties": false
}
},
"required": [
"id",
"alias",
"name",
"description",
"is_editable",
"is_removable",
"is_active"
]
}
},
"privacy_level": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"alias": {
"type": "string"
},
"name": {
"type": "string"
},
"level": {
"type": "number"
}
},
"required": [
"id",
"alias",
"name",
"level"
],
"additionalProperties": false
},
"pso_type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"system_required": {
"type": "boolean"
},
"creation_form_instance_id": {
"type": "number"
},
"profile_form_instance_id": {
"type": "number"
}
},
"required": [
"id",
"name",
"alias",
"description",
"is_active",
"system_required",
"creation_form_instance_id",
"profile_form_instance_id"
],
"additionalProperties": false
},
"items": {
"type": [
"array",
"null"
],
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"position": {
"type": "number"
},
"alias": {
"type": "string"
},
"has_unique_data": {
"type": "boolean",
"description": "whether field requires values to be unique across system"
},
"has_value": {
"type": "boolean",
"description": "whether field has at least one value submitted"
},
"removable": {
"type": "boolean",
"description": "whether field can be removed from system"
},
"is_active": {
"type": "boolean"
},
"list": {
"type": "boolean",
"description": "whether field can handle collection of values"
},
"read_only": {
"type": "boolean",
"description": "whether field value can be changed"
},
"required": {
"type": "boolean",
"description": "whether field value required by system"
},
"type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"settings": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"is_required": {
"type": "boolean"
}
},
"required": [
"id",
"name",
"alias",
"is_required"
]
}
},
"supports_collection": {
"type": "boolean"
},
"supports_read_only": {
"type": "boolean"
},
"supports_unique": {
"type": "boolean"
}
},
"required": [
"id",
"name",
"alias",
"settings",
"supports_collection",
"supports_read_only",
"supports_unique"
],
"additionalProperties": false
},
"category": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"alias": {
"type": "string"
},
"position": {
"type": "number"
},
"system_required": {
"type": "boolean"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"pso_type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"system_required": {
"type": "boolean"
},
"creation_form_instance_id": {
"type": "number"
},
"profile_form_instance_id": {
"type": "number"
}
},
"required": [
"id",
"name",
"alias",
"description",
"is_active",
"system_required",
"creation_form_instance_id",
"profile_form_instance_id"
],
"additionalProperties": false
}
},
"required": [
"id",
"alias",
"position",
"system_required",
"name",
"description",
"is_active"
],
"additionalProperties": false
},
"domains": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"alias": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"is_editable": {
"type": "boolean"
},
"is_removable": {
"type": "boolean"
},
"is_active": {
"type": "boolean"
},
"pso_type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"system_required": {
"type": "boolean"
},
"creation_form_instance_id": {
"type": "number"
},
"profile_form_instance_id": {
"type": "number"
}
},
"required": [
"id",
"name",
"alias",
"description",
"is_active",
"system_required",
"creation_form_instance_id",
"profile_form_instance_id"
],
"additionalProperties": false
}
},
"required": [
"id",
"alias",
"name",
"description",
"is_editable",
"is_removable",
"is_active"
]
}
},
"privacy_level": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"alias": {
"type": "string"
},
"name": {
"type": "string"
},
"level": {
"type": "number"
}
},
"required": [
"id",
"alias",
"name",
"level"
],
"additionalProperties": false
},
"pso_type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"system_required": {
"type": "boolean"
},
"creation_form_instance_id": {
"type": "number"
},
"profile_form_instance_id": {
"type": "number"
}
},
"required": [
"id",
"name",
"alias",
"description",
"is_active",
"system_required",
"creation_form_instance_id",
"profile_form_instance_id"
],
"additionalProperties": false
},
"items": {
"type": [
"array",
"null"
],
"items": {
"type": "object",
"properties": {}
}
},
"options": {
"type": [
"array",
"null"
],
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"position": {
"type": "number"
},
"value": {
"type": "string"
},
"is_active": {
"type": "boolean"
}
},
"required": [
"id",
"name",
"position",
"value",
"is_active"
]
},
"description": "List of options with possible (allowed) values."
},
"settings": {
"type": "array",
"items": {
"type": "string"
},
"description": "Common field settings"
}
},
"required": [
"id",
"name",
"position",
"alias",
"has_unique_data",
"has_value",
"removable",
"is_active",
"list",
"read_only",
"required"
]
}
},
"options": {
"type": [
"array",
"null"
],
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"position": {
"type": "number"
},
"value": {
"type": "string"
},
"is_active": {
"type": "boolean"
}
},
"required": [
"id",
"name",
"position",
"value",
"is_active"
]
},
"description": "List of options with possible (allowed) values."
},
"settings": {
"type": "array",
"items": {
"type": "string"
},
"description": "Common field settings"
},
"is_locked": {
"type": "boolean"
},
"value_details": {
"type": "array"
},
"values_count": {
"type": "number"
},
"assignment_settings": {
"type": "array"
},
"access_permissions": {
"type": "object",
"properties": {
"history": {
"type": "boolean"
},
"view": {
"type": "boolean"
},
"edit": {
"type": "boolean"
}
},
"required": [
"history",
"view",
"edit"
]
},
"assignment_permissions": {
"type": "object",
"properties": {
"permissions": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
}
},
"required": [
"id",
"name",
"alias"
]
},
"access_list": {
"type": "array",
"description": "user, manager, hr"
}
},
"required": [
"permissions",
"access_list"
]
}
},
"required": [
"id",
"name",
"position",
"alias",
"has_unique_data",
"has_value",
"removable",
"is_active",
"list",
"read_only",
"required",
"is_locked",
"value_details",
"values_count",
"assignment_settings",
"access_permissions",
"assignment_permissions"
]
}
}
},
"required": [
"id",
"status",
"approval_scheduled_date"
]
}
}
},
"required": [
"uuid",
"status",
"is_mass_edit",
"approval_scheduled_date"
]
}
},
"meta": {
"type": "object",
"properties": {
"pagination": {
"type": "object",
"properties": {
"total": {
"type": "number"
},
"count": {
"type": "number"
},
"per_page": {
"type": "number"
},
"current_page": {
"type": "number"
},
"total_pages": {
"type": "number"
},
"links": {
"type": "object",
"properties": {
"previous": {
"type": "string"
},
"next": {
"type": "string"
}
},
"required": [
"previous",
"next"
]
}
},
"required": [
"total",
"count",
"per_page",
"current_page",
"total_pages",
"links"
],
"additionalProperties": false
}
},
"required": [
"pagination"
]
}
}
}401Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 401
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}403Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 403
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}404Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 404
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}406Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 406
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}422Headers
Content-Type: application/jsonBody
{
"message": "Descriptive error message",
"status_code": 422,
"errors": [
"Error message"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
},
"errors": {
"type": "array"
}
}
}500Headers
Content-Type: application/jsonBody
{
"message": "Internal Error",
"status_code": 500
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}Show batchGET/scheduled-approvals/{uuid}/{?include}
Fetch batch of scheduled approvals items.
Example URI
- uuid
number(required) Example: 123Uuid of the Scheduled Approval batch.
- include
string(optional) Example: authorComma separated list of related resources that will be included into response. Possible values:
-
author
-
form_instance
-
scheduled_approvals.fields
-
scheduled_approvals.fields.type
-
scheduled_approvals.fields.category
-
scheduled_approvals.fields.category.pso_type
-
scheduled_approvals.fields.domains
-
scheduled_approvals.fields.domains.pso_type
-
scheduled_approvals.fields.pso_type
-
scheduled_approvals.fields.items
-
scheduled_approvals.fields.options
Note that includes uses kind of inheritance. So if you put
include=scheduled_approvals.fields.items.typeit will also populateitemsproperty for all fieldsIf you need to dive into and include related resources for sub-items you can use same options that
fieldsproperty has.For example:
include=scheduled_approvals.fields.items.typewill attach to the response all fields that assignment has.
Every includedfieldwill haveitemsproperty populated. Every item initemsproperty will havetypeproperty populatedBut, note: Unlike other forms with values array, “values” of composite will contain the structured tree of all subfields values.
-
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: '*'200Headers
Content-Type: application/jsonBody
{
"data": {
"uuid": "34425f31-d9f3-37bd-b90d-e5a7f7f85fc1",
"status": "pending",
"is_mass_edit": true,
"approval_scheduled_date": "2019-04-24 11:47:47",
"author": {
"id": 1,
"external_id": 1,
"first_name": "John",
"last_name": "Snow",
"username": "john_snow",
"professional_email": "jsnow@example.com",
"professional_mobile_phone": "00 33 1 40 00 00 00",
"professional_phone": "00 33 1 40 00 00 00",
"role": [
"bastard",
"king"
],
"is_active": true,
"status": "remote",
"settings": [
"[]"
],
"user_photo": "http://example.com/images/1.jpg"
},
"form_instance": {
"id": 1,
"name": {
"en": "Some text",
"fr": "Du texte",
"de": "Setwas Text",
"es": "Algún texto"
},
"description": {
"en": "Some text",
"fr": "Du texte",
"de": "Setwas Text",
"es": "Algún texto"
},
"form_id": 123,
"is_active": true,
"removable": false,
"effective_date": "2019-04-24 11:47:47"
},
"scheduled_approvals": [
{
"id": 1,
"status": "pending",
"approval_scheduled_date": "2019-04-24 11:47:47",
"pso": {
"id": 1,
"external_id": 1,
"first_name": "John",
"last_name": "Snow",
"username": "john_snow",
"professional_email": "jsnow@example.com",
"professional_mobile_phone": "00 33 1 40 00 00 00",
"professional_phone": "00 33 1 40 00 00 00",
"role": [
"bastard",
"king"
],
"is_active": true,
"status": "remote",
"settings": [
"[]"
],
"user_photo": "http://example.com/images/1.jpg"
},
"fields": [
{
"id": 1,
"name": "Field Name",
"position": 5,
"alias": "usr_first_name",
"has_unique_data": false,
"has_value": true,
"removable": false,
"is_active": true,
"list": false,
"read_only": false,
"required": true,
"type": {
"id": 1,
"name": "Data Type Name",
"alias": "data_type_alias",
"settings": [
{
"id": 1,
"name": "Data Type Setting Name",
"alias": "data_type_setting_alias",
"is_required": true
}
],
"supports_collection": false,
"supports_read_only": false,
"supports_unique": false
},
"category": {
"id": 32,
"alias": "usr_identity",
"position": 5,
"system_required": true,
"name": "Identity",
"description": "...",
"is_active": true,
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
}
},
"domains": [
{
"id": 46,
"alias": "usr_global",
"name": "User Global",
"description": "...",
"is_editable": false,
"is_removable": false,
"is_active": true,
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
}
}
],
"privacy_level": {
"id": 123,
"alias": "public",
"name": "Not Sensitive",
"level": 100
},
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
},
"items": [
{
"id": 1,
"name": "Field Name",
"position": 5,
"alias": "usr_first_name",
"has_unique_data": false,
"has_value": true,
"removable": false,
"is_active": true,
"list": false,
"read_only": false,
"required": true,
"type": {
"id": 1,
"name": "Data Type Name",
"alias": "data_type_alias",
"settings": [
{
"id": 1,
"name": "Data Type Setting Name",
"alias": "data_type_setting_alias",
"is_required": true
}
],
"supports_collection": false,
"supports_read_only": false,
"supports_unique": false
},
"category": {
"id": 32,
"alias": "usr_identity",
"position": 5,
"system_required": true,
"name": "Identity",
"description": "...",
"is_active": true,
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
}
},
"domains": [
{
"id": 46,
"alias": "usr_global",
"name": "User Global",
"description": "...",
"is_editable": false,
"is_removable": false,
"is_active": true,
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
}
}
],
"privacy_level": {
"id": 123,
"alias": "public",
"name": "Not Sensitive",
"level": 100
},
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
},
"items": [
{}
],
"options": [
{
"id": 198,
"name": "Chose me!",
"position": 9,
"value": "198",
"is_active": true
}
],
"settings": []
}
],
"options": [
{
"id": 198,
"name": "Chose me!",
"position": 9,
"value": "198",
"is_active": true
}
],
"settings": [],
"is_locked": false,
"value_details": [
"value1",
"value2"
],
"values_count": 2,
"assignment_settings": [
{
"setting": "public",
"value": "1"
}
],
"access_permissions": {
"history": true,
"view": true,
"edit": true
},
"assignment_permissions": {
"permissions": {
"id": 1,
"name": "View",
"alias": "view"
},
"access_list": [
"0",
"1",
"1"
]
}
}
]
}
]
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"uuid": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"pending",
"done",
"failed"
]
},
"is_mass_edit": {
"type": "boolean"
},
"approval_scheduled_date": {
"type": "string"
},
"author": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"external_id": {
"type": "number"
},
"first_name": {
"type": "string"
},
"last_name": {
"type": "string"
},
"username": {
"type": "string"
},
"professional_email": {
"type": "string"
},
"professional_mobile_phone": {
"type": "string"
},
"professional_phone": {
"type": "string"
},
"role": {
"type": "array"
},
"is_active": {
"type": "boolean"
},
"status": {
"type": "string"
},
"settings": {
"type": "array"
},
"user_photo": {
"type": "string"
}
},
"required": [
"id",
"external_id",
"first_name",
"last_name",
"username",
"professional_email",
"professional_mobile_phone",
"professional_phone",
"role",
"is_active",
"status",
"settings",
"user_photo"
],
"additionalProperties": false
},
"form_instance": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "object",
"properties": {
"en": {
"type": "string"
},
"fr": {
"type": "string"
},
"de": {
"type": "string"
},
"es": {
"type": "string"
}
},
"required": [
"en",
"fr",
"de",
"es"
]
},
"description": {
"type": "object",
"properties": {
"en": {
"type": "string"
},
"fr": {
"type": "string"
},
"de": {
"type": "string"
},
"es": {
"type": "string"
}
},
"required": [
"en",
"fr",
"de",
"es"
]
},
"form_id": {
"type": "number"
},
"is_active": {
"type": "boolean"
},
"removable": {
"type": "boolean"
},
"effective_date": {
"type": "string"
}
},
"required": [
"id",
"name",
"description",
"form_id",
"is_active",
"removable",
"effective_date"
],
"additionalProperties": false
},
"scheduled_approvals": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"status": {
"type": "string",
"enum": [
"pending",
"done",
"failed"
]
},
"approval_scheduled_date": {
"type": "string"
},
"pso": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"external_id": {
"type": "number"
},
"first_name": {
"type": "string"
},
"last_name": {
"type": "string"
},
"username": {
"type": "string"
},
"professional_email": {
"type": "string"
},
"professional_mobile_phone": {
"type": "string"
},
"professional_phone": {
"type": "string"
},
"role": {
"type": "array"
},
"is_active": {
"type": "boolean"
},
"status": {
"type": "string"
},
"settings": {
"type": "array"
},
"user_photo": {
"type": "string"
}
},
"required": [
"id",
"external_id",
"first_name",
"last_name",
"username",
"professional_email",
"professional_mobile_phone",
"professional_phone",
"role",
"is_active",
"status",
"settings",
"user_photo"
],
"additionalProperties": false
},
"fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"position": {
"type": "number"
},
"alias": {
"type": "string"
},
"has_unique_data": {
"type": "boolean",
"description": "whether field requires values to be unique across system"
},
"has_value": {
"type": "boolean",
"description": "whether field has at least one value submitted"
},
"removable": {
"type": "boolean",
"description": "whether field can be removed from system"
},
"is_active": {
"type": "boolean"
},
"list": {
"type": "boolean",
"description": "whether field can handle collection of values"
},
"read_only": {
"type": "boolean",
"description": "whether field value can be changed"
},
"required": {
"type": "boolean",
"description": "whether field value required by system"
},
"type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"settings": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"is_required": {
"type": "boolean"
}
},
"required": [
"id",
"name",
"alias",
"is_required"
]
}
},
"supports_collection": {
"type": "boolean"
},
"supports_read_only": {
"type": "boolean"
},
"supports_unique": {
"type": "boolean"
}
},
"required": [
"id",
"name",
"alias",
"settings",
"supports_collection",
"supports_read_only",
"supports_unique"
],
"additionalProperties": false
},
"category": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"alias": {
"type": "string"
},
"position": {
"type": "number"
},
"system_required": {
"type": "boolean"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"pso_type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"system_required": {
"type": "boolean"
},
"creation_form_instance_id": {
"type": "number"
},
"profile_form_instance_id": {
"type": "number"
}
},
"required": [
"id",
"name",
"alias",
"description",
"is_active",
"system_required",
"creation_form_instance_id",
"profile_form_instance_id"
],
"additionalProperties": false
}
},
"required": [
"id",
"alias",
"position",
"system_required",
"name",
"description",
"is_active"
],
"additionalProperties": false
},
"domains": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"alias": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"is_editable": {
"type": "boolean"
},
"is_removable": {
"type": "boolean"
},
"is_active": {
"type": "boolean"
},
"pso_type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"system_required": {
"type": "boolean"
},
"creation_form_instance_id": {
"type": "number"
},
"profile_form_instance_id": {
"type": "number"
}
},
"required": [
"id",
"name",
"alias",
"description",
"is_active",
"system_required",
"creation_form_instance_id",
"profile_form_instance_id"
],
"additionalProperties": false
}
},
"required": [
"id",
"alias",
"name",
"description",
"is_editable",
"is_removable",
"is_active"
]
}
},
"privacy_level": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"alias": {
"type": "string"
},
"name": {
"type": "string"
},
"level": {
"type": "number"
}
},
"required": [
"id",
"alias",
"name",
"level"
],
"additionalProperties": false
},
"pso_type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"system_required": {
"type": "boolean"
},
"creation_form_instance_id": {
"type": "number"
},
"profile_form_instance_id": {
"type": "number"
}
},
"required": [
"id",
"name",
"alias",
"description",
"is_active",
"system_required",
"creation_form_instance_id",
"profile_form_instance_id"
],
"additionalProperties": false
},
"items": {
"type": [
"array",
"null"
],
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"position": {
"type": "number"
},
"alias": {
"type": "string"
},
"has_unique_data": {
"type": "boolean",
"description": "whether field requires values to be unique across system"
},
"has_value": {
"type": "boolean",
"description": "whether field has at least one value submitted"
},
"removable": {
"type": "boolean",
"description": "whether field can be removed from system"
},
"is_active": {
"type": "boolean"
},
"list": {
"type": "boolean",
"description": "whether field can handle collection of values"
},
"read_only": {
"type": "boolean",
"description": "whether field value can be changed"
},
"required": {
"type": "boolean",
"description": "whether field value required by system"
},
"type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"settings": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"is_required": {
"type": "boolean"
}
},
"required": [
"id",
"name",
"alias",
"is_required"
]
}
},
"supports_collection": {
"type": "boolean"
},
"supports_read_only": {
"type": "boolean"
},
"supports_unique": {
"type": "boolean"
}
},
"required": [
"id",
"name",
"alias",
"settings",
"supports_collection",
"supports_read_only",
"supports_unique"
],
"additionalProperties": false
},
"category": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"alias": {
"type": "string"
},
"position": {
"type": "number"
},
"system_required": {
"type": "boolean"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"pso_type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"system_required": {
"type": "boolean"
},
"creation_form_instance_id": {
"type": "number"
},
"profile_form_instance_id": {
"type": "number"
}
},
"required": [
"id",
"name",
"alias",
"description",
"is_active",
"system_required",
"creation_form_instance_id",
"profile_form_instance_id"
],
"additionalProperties": false
}
},
"required": [
"id",
"alias",
"position",
"system_required",
"name",
"description",
"is_active"
],
"additionalProperties": false
},
"domains": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"alias": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"is_editable": {
"type": "boolean"
},
"is_removable": {
"type": "boolean"
},
"is_active": {
"type": "boolean"
},
"pso_type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"system_required": {
"type": "boolean"
},
"creation_form_instance_id": {
"type": "number"
},
"profile_form_instance_id": {
"type": "number"
}
},
"required": [
"id",
"name",
"alias",
"description",
"is_active",
"system_required",
"creation_form_instance_id",
"profile_form_instance_id"
],
"additionalProperties": false
}
},
"required": [
"id",
"alias",
"name",
"description",
"is_editable",
"is_removable",
"is_active"
]
}
},
"privacy_level": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"alias": {
"type": "string"
},
"name": {
"type": "string"
},
"level": {
"type": "number"
}
},
"required": [
"id",
"alias",
"name",
"level"
],
"additionalProperties": false
},
"pso_type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"system_required": {
"type": "boolean"
},
"creation_form_instance_id": {
"type": "number"
},
"profile_form_instance_id": {
"type": "number"
}
},
"required": [
"id",
"name",
"alias",
"description",
"is_active",
"system_required",
"creation_form_instance_id",
"profile_form_instance_id"
],
"additionalProperties": false
},
"items": {
"type": [
"array",
"null"
],
"items": {
"type": "object",
"properties": {}
}
},
"options": {
"type": [
"array",
"null"
],
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"position": {
"type": "number"
},
"value": {
"type": "string"
},
"is_active": {
"type": "boolean"
}
},
"required": [
"id",
"name",
"position",
"value",
"is_active"
]
},
"description": "List of options with possible (allowed) values."
},
"settings": {
"type": "array",
"items": {
"type": "string"
},
"description": "Common field settings"
}
},
"required": [
"id",
"name",
"position",
"alias",
"has_unique_data",
"has_value",
"removable",
"is_active",
"list",
"read_only",
"required"
]
}
},
"options": {
"type": [
"array",
"null"
],
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"position": {
"type": "number"
},
"value": {
"type": "string"
},
"is_active": {
"type": "boolean"
}
},
"required": [
"id",
"name",
"position",
"value",
"is_active"
]
},
"description": "List of options with possible (allowed) values."
},
"settings": {
"type": "array",
"items": {
"type": "string"
},
"description": "Common field settings"
},
"is_locked": {
"type": "boolean"
},
"value_details": {
"type": "array"
},
"values_count": {
"type": "number"
},
"assignment_settings": {
"type": "array"
},
"access_permissions": {
"type": "object",
"properties": {
"history": {
"type": "boolean"
},
"view": {
"type": "boolean"
},
"edit": {
"type": "boolean"
}
},
"required": [
"history",
"view",
"edit"
]
},
"assignment_permissions": {
"type": "object",
"properties": {
"permissions": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
}
},
"required": [
"id",
"name",
"alias"
]
},
"access_list": {
"type": "array",
"description": "user, manager, hr"
}
},
"required": [
"permissions",
"access_list"
]
}
},
"required": [
"id",
"name",
"position",
"alias",
"has_unique_data",
"has_value",
"removable",
"is_active",
"list",
"read_only",
"required",
"is_locked",
"value_details",
"values_count",
"assignment_settings",
"access_permissions",
"assignment_permissions"
]
}
}
},
"required": [
"id",
"status",
"approval_scheduled_date"
]
}
}
},
"required": [
"uuid",
"status",
"is_mass_edit",
"approval_scheduled_date",
"author",
"form_instance",
"scheduled_approvals"
],
"additionalProperties": false
}
}
}401Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 401
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}403Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 403
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}404Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 404
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}406Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 406
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}422Headers
Content-Type: application/jsonBody
{
"message": "Descriptive error message",
"status_code": 422,
"errors": [
"Error message"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
},
"errors": {
"type": "array"
}
}
}500Headers
Content-Type: application/jsonBody
{
"message": "Internal Error",
"status_code": 500
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}Show itemGET/scheduled-approvals/{uuid}/items/{id}{?include}
Fetch single scheduled approval item.
Example URI
- uuid
number(required) Example: 123Uuid of the Scheduled Approval batch.
- id
number(required) Example: 123Id of the Scheduled Approval item.
- include
string(optional) Example: authorComma separated list of related resources that will be included into response. Possible values:
-
author
-
form_instance
-
fields
-
fields.type
-
fields.category
-
fields.category.pso_type
-
fields.domains
-
fields.domains.pso_type
-
fields.pso_type
-
fields.items
-
fields.options
Note that includes uses kind of inheritance. So if you put
include=fields.items.typeit will also populateitemsproperty for all fieldsIf you need to dive into and include related resources for sub-items you can use same options that
fieldsproperty has.For example:
include=fields.items.typewill attach to the response all fields that assignment has.
Every includedfieldwill haveitemsproperty populated. Every item initemsproperty will havetypeproperty populatedBut, note: Unlike other forms with values array, “values” of composite will contain the structured tree of all subfields values.
-
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: '*'200Headers
Content-Type: application/jsonBody
{
"data": {
"id": 1,
"status": "pending",
"approval_scheduled_date": "2019-04-24 11:47:47",
"pso": {
"id": 1,
"external_id": 1,
"first_name": "John",
"last_name": "Snow",
"username": "john_snow",
"professional_email": "jsnow@example.com",
"professional_mobile_phone": "00 33 1 40 00 00 00",
"professional_phone": "00 33 1 40 00 00 00",
"role": [
"bastard",
"king"
],
"is_active": true,
"status": "remote",
"settings": [
"[]"
],
"user_photo": "http://example.com/images/1.jpg"
},
"fields": [
{
"id": 1,
"name": "Field Name",
"position": 5,
"alias": "usr_first_name",
"has_unique_data": false,
"has_value": true,
"removable": false,
"is_active": true,
"list": false,
"read_only": false,
"required": true,
"type": {
"id": 1,
"name": "Data Type Name",
"alias": "data_type_alias",
"settings": [
{
"id": 1,
"name": "Data Type Setting Name",
"alias": "data_type_setting_alias",
"is_required": true
}
],
"supports_collection": false,
"supports_read_only": false,
"supports_unique": false
},
"category": {
"id": 32,
"alias": "usr_identity",
"position": 5,
"system_required": true,
"name": "Identity",
"description": "...",
"is_active": true,
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
}
},
"domains": [
{
"id": 46,
"alias": "usr_global",
"name": "User Global",
"description": "...",
"is_editable": false,
"is_removable": false,
"is_active": true,
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
}
}
],
"privacy_level": {
"id": 123,
"alias": "public",
"name": "Not Sensitive",
"level": 100
},
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
},
"items": [
{
"id": 1,
"name": "Field Name",
"position": 5,
"alias": "usr_first_name",
"has_unique_data": false,
"has_value": true,
"removable": false,
"is_active": true,
"list": false,
"read_only": false,
"required": true,
"type": {
"id": 1,
"name": "Data Type Name",
"alias": "data_type_alias",
"settings": [
{
"id": 1,
"name": "Data Type Setting Name",
"alias": "data_type_setting_alias",
"is_required": true
}
],
"supports_collection": false,
"supports_read_only": false,
"supports_unique": false
},
"category": {
"id": 32,
"alias": "usr_identity",
"position": 5,
"system_required": true,
"name": "Identity",
"description": "...",
"is_active": true,
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
}
},
"domains": [
{
"id": 46,
"alias": "usr_global",
"name": "User Global",
"description": "...",
"is_editable": false,
"is_removable": false,
"is_active": true,
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
}
}
],
"privacy_level": {
"id": 123,
"alias": "public",
"name": "Not Sensitive",
"level": 100
},
"pso_type": {
"id": 56,
"name": "User",
"alias": "usr",
"description": "...",
"is_active": true,
"system_required": true,
"creation_form_instance_id": 1,
"profile_form_instance_id": 1
},
"items": [
{}
],
"options": [
{
"id": 198,
"name": "Chose me!",
"position": 9,
"value": "198",
"is_active": true
}
],
"settings": []
}
],
"options": [
{
"id": 198,
"name": "Chose me!",
"position": 9,
"value": "198",
"is_active": true
}
],
"settings": [],
"is_locked": false,
"value_details": [
"value1",
"value2"
],
"values_count": 2,
"assignment_settings": [
{
"setting": "public",
"value": "1"
}
],
"access_permissions": {
"history": true,
"view": true,
"edit": true
},
"assignment_permissions": {
"permissions": {
"id": 1,
"name": "View",
"alias": "view"
},
"access_list": [
"0",
"1",
"1"
]
}
}
]
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"status": {
"type": "string",
"enum": [
"pending",
"done",
"failed"
]
},
"approval_scheduled_date": {
"type": "string"
},
"pso": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"external_id": {
"type": "number"
},
"first_name": {
"type": "string"
},
"last_name": {
"type": "string"
},
"username": {
"type": "string"
},
"professional_email": {
"type": "string"
},
"professional_mobile_phone": {
"type": "string"
},
"professional_phone": {
"type": "string"
},
"role": {
"type": "array"
},
"is_active": {
"type": "boolean"
},
"status": {
"type": "string"
},
"settings": {
"type": "array"
},
"user_photo": {
"type": "string"
}
},
"required": [
"id",
"external_id",
"first_name",
"last_name",
"username",
"professional_email",
"professional_mobile_phone",
"professional_phone",
"role",
"is_active",
"status",
"settings",
"user_photo"
],
"additionalProperties": false
},
"fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"position": {
"type": "number"
},
"alias": {
"type": "string"
},
"has_unique_data": {
"type": "boolean",
"description": "whether field requires values to be unique across system"
},
"has_value": {
"type": "boolean",
"description": "whether field has at least one value submitted"
},
"removable": {
"type": "boolean",
"description": "whether field can be removed from system"
},
"is_active": {
"type": "boolean"
},
"list": {
"type": "boolean",
"description": "whether field can handle collection of values"
},
"read_only": {
"type": "boolean",
"description": "whether field value can be changed"
},
"required": {
"type": "boolean",
"description": "whether field value required by system"
},
"type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"settings": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"is_required": {
"type": "boolean"
}
},
"required": [
"id",
"name",
"alias",
"is_required"
]
}
},
"supports_collection": {
"type": "boolean"
},
"supports_read_only": {
"type": "boolean"
},
"supports_unique": {
"type": "boolean"
}
},
"required": [
"id",
"name",
"alias",
"settings",
"supports_collection",
"supports_read_only",
"supports_unique"
],
"additionalProperties": false
},
"category": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"alias": {
"type": "string"
},
"position": {
"type": "number"
},
"system_required": {
"type": "boolean"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"pso_type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"system_required": {
"type": "boolean"
},
"creation_form_instance_id": {
"type": "number"
},
"profile_form_instance_id": {
"type": "number"
}
},
"required": [
"id",
"name",
"alias",
"description",
"is_active",
"system_required",
"creation_form_instance_id",
"profile_form_instance_id"
],
"additionalProperties": false
}
},
"required": [
"id",
"alias",
"position",
"system_required",
"name",
"description",
"is_active"
],
"additionalProperties": false
},
"domains": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"alias": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"is_editable": {
"type": "boolean"
},
"is_removable": {
"type": "boolean"
},
"is_active": {
"type": "boolean"
},
"pso_type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"system_required": {
"type": "boolean"
},
"creation_form_instance_id": {
"type": "number"
},
"profile_form_instance_id": {
"type": "number"
}
},
"required": [
"id",
"name",
"alias",
"description",
"is_active",
"system_required",
"creation_form_instance_id",
"profile_form_instance_id"
],
"additionalProperties": false
}
},
"required": [
"id",
"alias",
"name",
"description",
"is_editable",
"is_removable",
"is_active"
]
}
},
"privacy_level": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"alias": {
"type": "string"
},
"name": {
"type": "string"
},
"level": {
"type": "number"
}
},
"required": [
"id",
"alias",
"name",
"level"
],
"additionalProperties": false
},
"pso_type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"system_required": {
"type": "boolean"
},
"creation_form_instance_id": {
"type": "number"
},
"profile_form_instance_id": {
"type": "number"
}
},
"required": [
"id",
"name",
"alias",
"description",
"is_active",
"system_required",
"creation_form_instance_id",
"profile_form_instance_id"
],
"additionalProperties": false
},
"items": {
"type": [
"array",
"null"
],
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"position": {
"type": "number"
},
"alias": {
"type": "string"
},
"has_unique_data": {
"type": "boolean",
"description": "whether field requires values to be unique across system"
},
"has_value": {
"type": "boolean",
"description": "whether field has at least one value submitted"
},
"removable": {
"type": "boolean",
"description": "whether field can be removed from system"
},
"is_active": {
"type": "boolean"
},
"list": {
"type": "boolean",
"description": "whether field can handle collection of values"
},
"read_only": {
"type": "boolean",
"description": "whether field value can be changed"
},
"required": {
"type": "boolean",
"description": "whether field value required by system"
},
"type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"settings": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"is_required": {
"type": "boolean"
}
},
"required": [
"id",
"name",
"alias",
"is_required"
]
}
},
"supports_collection": {
"type": "boolean"
},
"supports_read_only": {
"type": "boolean"
},
"supports_unique": {
"type": "boolean"
}
},
"required": [
"id",
"name",
"alias",
"settings",
"supports_collection",
"supports_read_only",
"supports_unique"
],
"additionalProperties": false
},
"category": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"alias": {
"type": "string"
},
"position": {
"type": "number"
},
"system_required": {
"type": "boolean"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"pso_type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"system_required": {
"type": "boolean"
},
"creation_form_instance_id": {
"type": "number"
},
"profile_form_instance_id": {
"type": "number"
}
},
"required": [
"id",
"name",
"alias",
"description",
"is_active",
"system_required",
"creation_form_instance_id",
"profile_form_instance_id"
],
"additionalProperties": false
}
},
"required": [
"id",
"alias",
"position",
"system_required",
"name",
"description",
"is_active"
],
"additionalProperties": false
},
"domains": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"alias": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"is_editable": {
"type": "boolean"
},
"is_removable": {
"type": "boolean"
},
"is_active": {
"type": "boolean"
},
"pso_type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"system_required": {
"type": "boolean"
},
"creation_form_instance_id": {
"type": "number"
},
"profile_form_instance_id": {
"type": "number"
}
},
"required": [
"id",
"name",
"alias",
"description",
"is_active",
"system_required",
"creation_form_instance_id",
"profile_form_instance_id"
],
"additionalProperties": false
}
},
"required": [
"id",
"alias",
"name",
"description",
"is_editable",
"is_removable",
"is_active"
]
}
},
"privacy_level": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"alias": {
"type": "string"
},
"name": {
"type": "string"
},
"level": {
"type": "number"
}
},
"required": [
"id",
"alias",
"name",
"level"
],
"additionalProperties": false
},
"pso_type": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
},
"description": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"system_required": {
"type": "boolean"
},
"creation_form_instance_id": {
"type": "number"
},
"profile_form_instance_id": {
"type": "number"
}
},
"required": [
"id",
"name",
"alias",
"description",
"is_active",
"system_required",
"creation_form_instance_id",
"profile_form_instance_id"
],
"additionalProperties": false
},
"items": {
"type": [
"array",
"null"
],
"items": {
"type": "object",
"properties": {}
}
},
"options": {
"type": [
"array",
"null"
],
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"position": {
"type": "number"
},
"value": {
"type": "string"
},
"is_active": {
"type": "boolean"
}
},
"required": [
"id",
"name",
"position",
"value",
"is_active"
]
},
"description": "List of options with possible (allowed) values."
},
"settings": {
"type": "array",
"items": {
"type": "string"
},
"description": "Common field settings"
}
},
"required": [
"id",
"name",
"position",
"alias",
"has_unique_data",
"has_value",
"removable",
"is_active",
"list",
"read_only",
"required"
]
}
},
"options": {
"type": [
"array",
"null"
],
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"position": {
"type": "number"
},
"value": {
"type": "string"
},
"is_active": {
"type": "boolean"
}
},
"required": [
"id",
"name",
"position",
"value",
"is_active"
]
},
"description": "List of options with possible (allowed) values."
},
"settings": {
"type": "array",
"items": {
"type": "string"
},
"description": "Common field settings"
},
"is_locked": {
"type": "boolean"
},
"value_details": {
"type": "array"
},
"values_count": {
"type": "number"
},
"assignment_settings": {
"type": "array"
},
"access_permissions": {
"type": "object",
"properties": {
"history": {
"type": "boolean"
},
"view": {
"type": "boolean"
},
"edit": {
"type": "boolean"
}
},
"required": [
"history",
"view",
"edit"
]
},
"assignment_permissions": {
"type": "object",
"properties": {
"permissions": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"alias": {
"type": "string"
}
},
"required": [
"id",
"name",
"alias"
]
},
"access_list": {
"type": "array",
"description": "user, manager, hr"
}
},
"required": [
"permissions",
"access_list"
]
}
},
"required": [
"id",
"name",
"position",
"alias",
"has_unique_data",
"has_value",
"removable",
"is_active",
"list",
"read_only",
"required",
"is_locked",
"value_details",
"values_count",
"assignment_settings",
"access_permissions",
"assignment_permissions"
]
}
}
},
"required": [
"id",
"status",
"approval_scheduled_date",
"pso",
"fields"
],
"additionalProperties": false
}
}
}401Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 401
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}403Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 403
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}404Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 404
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}406Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 406
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}422Headers
Content-Type: application/jsonBody
{
"message": "Descriptive error message",
"status_code": 422,
"errors": [
"Error message"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
},
"errors": {
"type": "array"
}
}
}500Headers
Content-Type: application/jsonBody
{
"message": "Internal Error",
"status_code": 500
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}Delete batchDELETE/scheduled-approvals/{uuid}
Delete all scheduled approvals in mass edit batch
Example URI
- uuid
number(required) Example: 123Uuid of the Scheduled Approval batch.
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: '*'204Headers
Content-Type: application/json401Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 401
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}403Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 403
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}404Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 404
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}406Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 406
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}422Headers
Content-Type: application/jsonBody
{
"message": "Descriptive error message",
"status_code": 422,
"errors": [
"Error message"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
},
"errors": {
"type": "array"
}
}
}500Headers
Content-Type: application/jsonBody
{
"message": "Internal Error",
"status_code": 500
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}Delete itemDELETE/scheduled-approvals/{uuid}/items/{id}
Delete scheduled approval item
Example URI
- uuid
number(required) Example: 123Uuid of the Scheduled Approval batch.
- id
number(required) Example: 123Id of the Scheduled Approval item.
Headers
Accept: application/json
Content-Type: application/json
X-Application-Version: <client-name>/<version>
X-App-features: '*'204Headers
Content-Type: application/json401Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 401
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}403Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 403
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}404Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 404
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}406Headers
Content-Type: application/jsonBody
{
"message": "Short description of error reason",
"status_code": 406
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}422Headers
Content-Type: application/jsonBody
{
"message": "Descriptive error message",
"status_code": 422,
"errors": [
"Error message"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
},
"errors": {
"type": "array"
}
}
}500Headers
Content-Type: application/jsonBody
{
"message": "Internal Error",
"status_code": 500
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"message": {
"type": "string"
},
"status_code": {
"type": "number"
}
}
}